@kameleoon/react-sdk 8.5.2 → 9.0.0

package/dist/KameleoonContext.js

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.KameleoonContext=void 0;var _react=require("react"),KameleoonContext=(0,_react.createContext)(null);exports.KameleoonContext=KameleoonContext;
+"use strict";var _react=require("react");Object.defineProperty(exports,"__esModule",{value:!0}),exports.KameleoonContext=void 0;const KameleoonContext=exports.KameleoonContext=(0,_react.createContext)(null);
 //# sourceMappingURL=KameleoonContext.js.map

package/dist/KameleoonContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"KameleoonContext.js","names":["KameleoonContext","createContext","exports"],"sources":["../src/KameleoonContext.ts"],"sourcesContent":["import { createContext } from 'react';\nimport { KameleoonContextType } from './types';\n\nexport const KameleoonContext = createContext<KameleoonContextType | null>(\n  null,\n);\n"],"mappings":"gIAGaA,gBAAgB,CAAG,GAAAC,oBAAa,EAC3C,IAAI,CACL,CAAAC,OAAA,CAAAF,gBAAA,CAAAA,gBAAA"}
+{"version":3,"file":"KameleoonContext.js","names":["_react","require","Object","defineProperty","exports","value","KameleoonContext","createContext"],"sources":["../src/KameleoonContext.ts"],"sourcesContent":["import { createContext } from 'react';\nimport { KameleoonClient } from '@kameleoon/javascript-sdk';\n\nexport const KameleoonContext = createContext<KameleoonClient | null>(null);\n"],"mappings":"aAAA,IAAAA,MAAA,CAAAC,OAAA,UAAsCC,MAAA,CAAAC,cAAA,CAAAC,OAAA,eAAAC,KAAA,MAAAD,OAAA,CAAAE,gBAAA,QAG/B,KAAM,CAAAA,gBAAgB,CAAAF,OAAA,CAAAE,gBAAA,CAAG,GAAAC,oBAAa,EAAyB,IAAI,CAAC"}

package/dist/KameleoonProvider.d.ts

@@ -1,14 +1,14 @@
-import React, { ReactNode } from 'react';
-import { KameleoonContextType } from './types';
+import { ReactNode } from 'react';
+import { KameleoonClient } from '@kameleoon/javascript-sdk';
 export interface IKameleoonProviderProps {
     /** Child elements of the provider. */
     children: ReactNode;
-    /** An instance of KameleoonClient. */
-    client: KameleoonContextType;
+    /** An instance of Kameleoon SDK. */
+    client: KameleoonClient;
 }
 /**
  * A Provider that wraps the project and provides an access to SDK APIs
  */
 declare function KameleoonProvider({ client, children, }: IKameleoonProviderProps): JSX.Element;
-declare const _default: React.MemoExoticComponent<typeof KameleoonProvider>;
+declare const _default: import("react").MemoExoticComponent<typeof KameleoonProvider>;
 export default _default;

package/dist/KameleoonProvider.js

@@ -1,2 +1,2 @@
-"use strict";function _typeof(a){"@babel/helpers - typeof";return _typeof="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(a){return typeof a}:function(a){return a&&"function"==typeof Symbol&&a.constructor===Symbol&&a!==Symbol.prototype?"symbol":typeof a},_typeof(a)}Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0;var _react=_interopRequireWildcard(require("react")),_KameleoonContext=require("./KameleoonContext");function _getRequireWildcardCache(a){if("function"!=typeof WeakMap)return null;var b=new WeakMap,c=new WeakMap;return(_getRequireWildcardCache=function(a){return a?c:b})(a)}function _interopRequireWildcard(a,b){if(!b&&a&&a.__esModule)return a;if(null===a||"object"!==_typeof(a)&&"function"!=typeof a)return{default:a};var c=_getRequireWildcardCache(b);if(c&&c.has(a))return c.get(a);var d={},e=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var f in a)if("default"!=f&&Object.prototype.hasOwnProperty.call(a,f)){var g=e?Object.getOwnPropertyDescriptor(a,f):null;g&&(g.get||g.set)?Object.defineProperty(d,f,g):d[f]=a[f]}return d.default=a,c&&c.set(a,d),d}function KameleoonProvider(a){var b=a.client,c=a.children;return _react.default.createElement(_KameleoonContext.KameleoonContext.Provider,{value:b},c)}var _default=(0,_react.memo)(KameleoonProvider);exports.default=_default;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0;var _react=require("react"),_KameleoonContext=require("./KameleoonContext");function KameleoonProvider(a){let{client:b,children:c}=a;return React.createElement(_KameleoonContext.KameleoonContext.Provider,{value:b},c)}var _default=exports.default=(0,_react.memo)(KameleoonProvider);
 //# sourceMappingURL=KameleoonProvider.js.map

package/dist/KameleoonProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"KameleoonProvider.js","names":["KameleoonProvider","a","client","children","_react","default","createElement","_KameleoonContext","KameleoonContext","Provider","value","_default","memo","exports"],"sources":["../src/KameleoonProvider.tsx"],"sourcesContent":["import React, { memo, ReactNode } from 'react';\nimport { KameleoonContext } from './KameleoonContext';\nimport { KameleoonContextType } from './types';\n\nexport interface IKameleoonProviderProps {\n  /** Child elements of the provider. */\n  children: ReactNode;\n  /** An instance of KameleoonClient. */\n  client: KameleoonContextType;\n}\n\n/**\n * A Provider that wraps the project and provides an access to SDK APIs\n */\nfunction KameleoonProvider({\n  client,\n  children,\n}: IKameleoonProviderProps): JSX.Element {\n  return (\n    <KameleoonContext.Provider value={client}>\n      {children}\n    </KameleoonContext.Provider>\n  );\n}\n\nexport default memo(KameleoonProvider);\n"],"mappings":"4mCAcA,QAAS,CAAAA,iBAAiBA,CAAAC,CAAA,CAGe,IAFvC,CAAAC,CAAM,CAAAD,CAAA,CAANC,MAAM,CACNC,CAAQ,CAAAF,CAAA,CAARE,QAAQ,CAER,MACE,CAAAC,MAAA,CAAAC,OAAA,CAAAC,aAAA,CAACC,iBAAA,CAAAC,gBAAgB,CAACC,QAAQ,EAACC,KAAK,CAAER,CAAO,EACtCC,CAAQ,CAGf,CAAC,IAAAQ,QAAA,CAEc,GAAAC,WAAI,EAACZ,iBAAiB,CAAC,CAAAa,OAAA,CAAAR,OAAA,CAAAM,QAAA"}
+{"version":3,"file":"KameleoonProvider.js","names":["KameleoonProvider","a","client","children","React","createElement","_KameleoonContext","KameleoonContext","Provider","value","_default","exports","default","memo"],"sources":["../src/KameleoonProvider.tsx"],"sourcesContent":["import { memo, ReactNode } from 'react';\nimport { KameleoonClient } from '@kameleoon/javascript-sdk';\nimport { KameleoonContext } from './KameleoonContext';\n\nexport interface IKameleoonProviderProps {\n  /** Child elements of the provider. */\n  children: ReactNode;\n  /** An instance of Kameleoon SDK. */\n  client: KameleoonClient;\n}\n\n/**\n * A Provider that wraps the project and provides an access to SDK APIs\n */\nfunction KameleoonProvider({\n  client,\n  children,\n}: IKameleoonProviderProps): JSX.Element {\n  return (\n    <KameleoonContext.Provider value={client}>\n      {children}\n    </KameleoonContext.Provider>\n  );\n}\n\nexport default memo(KameleoonProvider);\n"],"mappings":"uKAcA,QAAS,CAAAA,iBAAiBA,CAAAC,CAAA,CAGe,IAHd,CACzBC,MAAM,CAANA,CAAM,CACNC,QAAQ,CAARA,CACuB,CAAC,CAAAF,CAAA,CACxB,MACE,CAAAG,KAAA,CAAAC,aAAA,CAACC,iBAAA,CAAAC,gBAAgB,CAACC,QAAQ,EAACC,KAAK,CAAEP,CAAO,EACtCC,CACwB,CAE/B,CAAC,IAAAO,QAAA,CAAAC,OAAA,CAAAC,OAAA,CAEc,GAAAC,WAAI,EAACb,iBAAiB,CAAC"}

package/dist/createClient.d.ts

@@ -0,0 +1,6 @@
+import { KameleoonClient, SDKParameters } from '@kameleoon/javascript-sdk';
+/**
+ * Creates an instance of KameleoonClient
+ * @param parameters {SDKParameters} - parameters of an SDK
+ */
+export declare function createClient({ siteCode, configuration, externals, }: SDKParameters): KameleoonClient;

package/dist/createClient.js

@@ -0,0 +1,2 @@
+"use strict";var _javascriptSdk=require("@kameleoon/javascript-sdk");Object.defineProperty(exports,"__esModule",{value:!0}),exports.createClient=createClient;function createClient(a){let{siteCode:b,configuration:c,externals:d}=a;const e=new _javascriptSdk.KameleoonClient({siteCode:b,configuration:c,externals:d,_internals:{type:_javascriptSdk.SdkLanguageType.REACT,version:"9.0.0"}});return e}
+//# sourceMappingURL=createClient.js.map

package/dist/createClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createClient.js","names":["_javascriptSdk","require","Object","defineProperty","exports","value","createClient","a","siteCode","configuration","externals","client","KameleoonClient","_internals","type","SdkLanguageType","REACT","version"],"sources":["../src/createClient.ts"],"sourcesContent":["import {\n  KameleoonClient,\n  SDKParameters,\n  SdkLanguageType,\n} from '@kameleoon/javascript-sdk';\n\n/**\n * Creates an instance of KameleoonClient\n * @param parameters {SDKParameters} - parameters of an SDK\n */\nexport function createClient({\n  siteCode,\n  configuration,\n  externals,\n}: SDKParameters): KameleoonClient {\n  const client = new KameleoonClient({\n    siteCode,\n    configuration,\n    externals,\n    _internals: {\n      type: SdkLanguageType.REACT,\n      version: process.env.npm_package_version as string,\n    },\n  });\n\n  return client;\n}\n"],"mappings":"aAAA,IAAAA,cAAA,CAAAC,OAAA,8BAImCC,MAAA,CAAAC,cAAA,CAAAC,OAAA,eAAAC,KAAA,MAAAD,OAAA,CAAAE,YAAA,CAAAA,YAAA,CAM5B,QAAS,CAAAA,YAAYA,CAAAC,CAAA,CAIO,IAJN,CAC3BC,QAAQ,CAARA,CAAQ,CACRC,aAAa,CAAbA,CAAa,CACbC,SAAS,CAATA,CACa,CAAC,CAAAH,CAAA,CACd,KAAM,CAAAI,CAAM,CAAG,GAAI,CAAAC,8BAAe,CAAC,CACjCJ,QAAQ,CAARA,CAAQ,CACRC,aAAa,CAAbA,CAAa,CACbC,SAAS,CAATA,CAAS,CACTG,UAAU,CAAE,CACVC,IAAI,CAAEC,8BAAe,CAACC,KAAK,CAC3BC,OAAO,QACT,CACF,CAAC,CAAC,CAEF,MAAO,CAAAN,CACT"}

package/dist/index.d.ts

@@ -1,26 +1,13 @@
-export { Device, Browser, PageView, JSONType, Conversion, CustomData, DeviceType, BrowserType, Environment, VariableType, KameleoonError, FeatureFlagType, KameleoonDataType, ApplicationVersion, KameleoonException, KameleoonStorageKey, FeatureVariableResultType, ApplicationVersionDataType, RemoteVisitorDataParamsType, } from '@kameleoon/javascript-sdk-core';
-export type { SDKParameters } from './types';
+export * from '@kameleoon/javascript-sdk';
 export { default as KameleoonProvider, IKameleoonProviderProps, } from './KameleoonProvider';
-export { KameleoonContext } from './KameleoonContext';
+export { useData } from './useData';
+export { useInitialize } from './useInitialize';
+export { useFeatureFlag } from './useFeatureFlag';
+export { useVisitorCode } from './useVisitorCode';
+export { default as IUseData } from './interfaces/useData';
+export { default as IUseInitialize } from './interfaces/useInitialize';
+export { default as IUseFeatureFlag } from './interfaces/useFeatureFlag';
+export { default as IUseVisitorCode } from './interfaces/useVisitorCode';
 export { useKameleoon } from './useKameleoon';
-export { createClient } from './kameleoonClient';
-export { useInitialize, IInitializeHookResult } from './useInitialize';
-export { useFeatureFlags, IFeatureFlagsHookResult } from './useFeatureFlags';
-export { useRemoteData, IRemoteDataHookResult } from './useRemoteData';
-export { useRemoteVisitorData, IRemoteVisitorDataHookResult, } from './useRemoteVisitorData';
-export { useAddData, IAddDataHookResult } from './useAddData';
-export { useFlush, IFlushHookResult } from './useFlush';
-export { useReactVisitorCode, IReactVisitorCodeHookResult, } from './useReactVisitorCode';
-export { useReactNativeVisitorCode, IReactNativeVisitorCodeHookResult, } from './useReactNativeVisitorCode';
-export { useBrowserVisitorCode, IBrowserVisitorCodeHookResult, } from './useBrowserVisitorCode';
-export { useNativeVisitorCode, INativeVisitorCodeHookResult, } from './useNativeVisitorCode';
-export { useVisitorFeatureFlags, IVisitorFeatureFlagsHookResult, } from './useVisitorFeatureFlags';
-export { useFeatureFlagVariationKey, IFeatureFlagVariationKeyHookResult, } from './useFeatureFlagVariationKey';
-export { useFeatureFlagActive, IFeatureFlagActiveHookResult, } from './useFeatureFlagActive';
-export { useEngineTrackingCode, IEngineTrackingCodeHookResult, } from './useEngineTrackingCode';
-export { useFeatureVariable, IFeatureVariableHookResult, } from './useFeatureVariable';
-export { useFeatureVariables, IFeatureVariablesHookResult, } from './useFeatureVariables';
-export { useVisitorWarehouseAudience, IVisitorWarehouseAudienceHookResult, } from './useVisitorWarehouseAudience';
-export { useTrackConversion, ITrackConversionHookResult, } from './useTrackConversion';
-export { useConfigurationUpdate, IConfigurationUpdateHookResult, } from './useConfigurationUpdate';
-export { useSetLegalConsent, ISetLegalConsentHookResult, } from './useSetLegalConsent';
+export { KameleoonContext } from './KameleoonContext';
+export { createClient } from './createClient';

package/dist/index.js

@@ -1,2 +1,2 @@
-"use strict";function _typeof(a){"@babel/helpers - typeof";return _typeof="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(a){return typeof a}:function(a){return a&&"function"==typeof Symbol&&a.constructor===Symbol&&a!==Symbol.prototype?"symbol":typeof a},_typeof(a)}Object.defineProperty(exports,"__esModule",{value:!0}),Object.defineProperty(exports,"ApplicationVersion",{enumerable:!0,get:function get(){return _javascriptSdkCore.ApplicationVersion}}),Object.defineProperty(exports,"ApplicationVersionDataType",{enumerable:!0,get:function get(){return _javascriptSdkCore.ApplicationVersionDataType}}),Object.defineProperty(exports,"Browser",{enumerable:!0,get:function get(){return _javascriptSdkCore.Browser}}),Object.defineProperty(exports,"BrowserType",{enumerable:!0,get:function get(){return _javascriptSdkCore.BrowserType}}),Object.defineProperty(exports,"Conversion",{enumerable:!0,get:function get(){return _javascriptSdkCore.Conversion}}),Object.defineProperty(exports,"CustomData",{enumerable:!0,get:function get(){return _javascriptSdkCore.CustomData}}),Object.defineProperty(exports,"Device",{enumerable:!0,get:function get(){return _javascriptSdkCore.Device}}),Object.defineProperty(exports,"DeviceType",{enumerable:!0,get:function get(){return _javascriptSdkCore.DeviceType}}),Object.defineProperty(exports,"Environment",{enumerable:!0,get:function get(){return _javascriptSdkCore.Environment}}),Object.defineProperty(exports,"FeatureFlagType",{enumerable:!0,get:function get(){return _javascriptSdkCore.FeatureFlagType}}),Object.defineProperty(exports,"FeatureVariableResultType",{enumerable:!0,get:function get(){return _javascriptSdkCore.FeatureVariableResultType}}),Object.defineProperty(exports,"IAddDataHookResult",{enumerable:!0,get:function get(){return _useAddData.IAddDataHookResult}}),Object.defineProperty(exports,"IBrowserVisitorCodeHookResult",{enumerable:!0,get:function get(){return _useBrowserVisitorCode.IBrowserVisitorCodeHookResult}}),Object.defineProperty(exports,"IConfigurationUpdateHookResult",{enumerable:!0,get:function get(){return _useConfigurationUpdate.IConfigurationUpdateHookResult}}),Object.defineProperty(exports,"IEngineTrackingCodeHookResult",{enumerable:!0,get:function get(){return _useEngineTrackingCode.IEngineTrackingCodeHookResult}}),Object.defineProperty(exports,"IFeatureFlagActiveHookResult",{enumerable:!0,get:function get(){return _useFeatureFlagActive.IFeatureFlagActiveHookResult}}),Object.defineProperty(exports,"IFeatureFlagVariationKeyHookResult",{enumerable:!0,get:function get(){return _useFeatureFlagVariationKey.IFeatureFlagVariationKeyHookResult}}),Object.defineProperty(exports,"IFeatureFlagsHookResult",{enumerable:!0,get:function get(){return _useFeatureFlags.IFeatureFlagsHookResult}}),Object.defineProperty(exports,"IFeatureVariableHookResult",{enumerable:!0,get:function get(){return _useFeatureVariable.IFeatureVariableHookResult}}),Object.defineProperty(exports,"IFeatureVariablesHookResult",{enumerable:!0,get:function get(){return _useFeatureVariables.IFeatureVariablesHookResult}}),Object.defineProperty(exports,"IFlushHookResult",{enumerable:!0,get:function get(){return _useFlush.IFlushHookResult}}),Object.defineProperty(exports,"IInitializeHookResult",{enumerable:!0,get:function get(){return _useInitialize.IInitializeHookResult}}),Object.defineProperty(exports,"IKameleoonProviderProps",{enumerable:!0,get:function get(){return _KameleoonProvider.IKameleoonProviderProps}}),Object.defineProperty(exports,"INativeVisitorCodeHookResult",{enumerable:!0,get:function get(){return _useNativeVisitorCode.INativeVisitorCodeHookResult}}),Object.defineProperty(exports,"IReactNativeVisitorCodeHookResult",{enumerable:!0,get:function get(){return _useReactNativeVisitorCode.IReactNativeVisitorCodeHookResult}}),Object.defineProperty(exports,"IReactVisitorCodeHookResult",{enumerable:!0,get:function get(){return _useReactVisitorCode.IReactVisitorCodeHookResult}}),Object.defineProperty(exports,"IRemoteDataHookResult",{enumerable:!0,get:function get(){return _useRemoteData.IRemoteDataHookResult}}),Object.defineProperty(exports,"IRemoteVisitorDataHookResult",{enumerable:!0,get:function get(){return _useRemoteVisitorData.IRemoteVisitorDataHookResult}}),Object.defineProperty(exports,"ISetLegalConsentHookResult",{enumerable:!0,get:function get(){return _useSetLegalConsent.ISetLegalConsentHookResult}}),Object.defineProperty(exports,"ITrackConversionHookResult",{enumerable:!0,get:function get(){return _useTrackConversion.ITrackConversionHookResult}}),Object.defineProperty(exports,"IVisitorFeatureFlagsHookResult",{enumerable:!0,get:function get(){return _useVisitorFeatureFlags.IVisitorFeatureFlagsHookResult}}),Object.defineProperty(exports,"IVisitorWarehouseAudienceHookResult",{enumerable:!0,get:function get(){return _useVisitorWarehouseAudience.IVisitorWarehouseAudienceHookResult}}),Object.defineProperty(exports,"JSONType",{enumerable:!0,get:function get(){return _javascriptSdkCore.JSONType}}),Object.defineProperty(exports,"KameleoonContext",{enumerable:!0,get:function get(){return _KameleoonContext.KameleoonContext}}),Object.defineProperty(exports,"KameleoonDataType",{enumerable:!0,get:function get(){return _javascriptSdkCore.KameleoonDataType}}),Object.defineProperty(exports,"KameleoonError",{enumerable:!0,get:function get(){return _javascriptSdkCore.KameleoonError}}),Object.defineProperty(exports,"KameleoonException",{enumerable:!0,get:function get(){return _javascriptSdkCore.KameleoonException}}),Object.defineProperty(exports,"KameleoonProvider",{enumerable:!0,get:function get(){return _KameleoonProvider.default}}),Object.defineProperty(exports,"KameleoonStorageKey",{enumerable:!0,get:function get(){return _javascriptSdkCore.KameleoonStorageKey}}),Object.defineProperty(exports,"PageView",{enumerable:!0,get:function get(){return _javascriptSdkCore.PageView}}),Object.defineProperty(exports,"RemoteVisitorDataParamsType",{enumerable:!0,get:function get(){return _javascriptSdkCore.RemoteVisitorDataParamsType}}),Object.defineProperty(exports,"VariableType",{enumerable:!0,get:function get(){return _javascriptSdkCore.VariableType}}),Object.defineProperty(exports,"createClient",{enumerable:!0,get:function get(){return _kameleoonClient.createClient}}),Object.defineProperty(exports,"useAddData",{enumerable:!0,get:function get(){return _useAddData.useAddData}}),Object.defineProperty(exports,"useBrowserVisitorCode",{enumerable:!0,get:function get(){return _useBrowserVisitorCode.useBrowserVisitorCode}}),Object.defineProperty(exports,"useConfigurationUpdate",{enumerable:!0,get:function get(){return _useConfigurationUpdate.useConfigurationUpdate}}),Object.defineProperty(exports,"useEngineTrackingCode",{enumerable:!0,get:function get(){return _useEngineTrackingCode.useEngineTrackingCode}}),Object.defineProperty(exports,"useFeatureFlagActive",{enumerable:!0,get:function get(){return _useFeatureFlagActive.useFeatureFlagActive}}),Object.defineProperty(exports,"useFeatureFlagVariationKey",{enumerable:!0,get:function get(){return _useFeatureFlagVariationKey.useFeatureFlagVariationKey}}),Object.defineProperty(exports,"useFeatureFlags",{enumerable:!0,get:function get(){return _useFeatureFlags.useFeatureFlags}}),Object.defineProperty(exports,"useFeatureVariable",{enumerable:!0,get:function get(){return _useFeatureVariable.useFeatureVariable}}),Object.defineProperty(exports,"useFeatureVariables",{enumerable:!0,get:function get(){return _useFeatureVariables.useFeatureVariables}}),Object.defineProperty(exports,"useFlush",{enumerable:!0,get:function get(){return _useFlush.useFlush}}),Object.defineProperty(exports,"useInitialize",{enumerable:!0,get:function get(){return _useInitialize.useInitialize}}),Object.defineProperty(exports,"useKameleoon",{enumerable:!0,get:function get(){return _useKameleoon.useKameleoon}}),Object.defineProperty(exports,"useNativeVisitorCode",{enumerable:!0,get:function get(){return _useNativeVisitorCode.useNativeVisitorCode}}),Object.defineProperty(exports,"useReactNativeVisitorCode",{enumerable:!0,get:function get(){return _useReactNativeVisitorCode.useReactNativeVisitorCode}}),Object.defineProperty(exports,"useReactVisitorCode",{enumerable:!0,get:function get(){return _useReactVisitorCode.useReactVisitorCode}}),Object.defineProperty(exports,"useRemoteData",{enumerable:!0,get:function get(){return _useRemoteData.useRemoteData}}),Object.defineProperty(exports,"useRemoteVisitorData",{enumerable:!0,get:function get(){return _useRemoteVisitorData.useRemoteVisitorData}}),Object.defineProperty(exports,"useSetLegalConsent",{enumerable:!0,get:function get(){return _useSetLegalConsent.useSetLegalConsent}}),Object.defineProperty(exports,"useTrackConversion",{enumerable:!0,get:function get(){return _useTrackConversion.useTrackConversion}}),Object.defineProperty(exports,"useVisitorFeatureFlags",{enumerable:!0,get:function get(){return _useVisitorFeatureFlags.useVisitorFeatureFlags}}),Object.defineProperty(exports,"useVisitorWarehouseAudience",{enumerable:!0,get:function get(){return _useVisitorWarehouseAudience.useVisitorWarehouseAudience}});var _javascriptSdkCore=require("@kameleoon/javascript-sdk-core"),_KameleoonProvider=_interopRequireWildcard(require("./KameleoonProvider")),_KameleoonContext=require("./KameleoonContext"),_useKameleoon=require("./useKameleoon"),_kameleoonClient=require("./kameleoonClient"),_useInitialize=require("./useInitialize"),_useFeatureFlags=require("./useFeatureFlags"),_useRemoteData=require("./useRemoteData"),_useRemoteVisitorData=require("./useRemoteVisitorData"),_useAddData=require("./useAddData"),_useFlush=require("./useFlush"),_useReactVisitorCode=require("./useReactVisitorCode"),_useReactNativeVisitorCode=require("./useReactNativeVisitorCode"),_useBrowserVisitorCode=require("./useBrowserVisitorCode"),_useNativeVisitorCode=require("./useNativeVisitorCode"),_useVisitorFeatureFlags=require("./useVisitorFeatureFlags"),_useFeatureFlagVariationKey=require("./useFeatureFlagVariationKey"),_useFeatureFlagActive=require("./useFeatureFlagActive"),_useEngineTrackingCode=require("./useEngineTrackingCode"),_useFeatureVariable=require("./useFeatureVariable"),_useFeatureVariables=require("./useFeatureVariables"),_useVisitorWarehouseAudience=require("./useVisitorWarehouseAudience"),_useTrackConversion=require("./useTrackConversion"),_useConfigurationUpdate=require("./useConfigurationUpdate"),_useSetLegalConsent=require("./useSetLegalConsent");function _getRequireWildcardCache(a){if("function"!=typeof WeakMap)return null;var b=new WeakMap,c=new WeakMap;return(_getRequireWildcardCache=function(a){return a?c:b})(a)}function _interopRequireWildcard(a,b){if(!b&&a&&a.__esModule)return a;if(null===a||"object"!==_typeof(a)&&"function"!=typeof a)return{default:a};var c=_getRequireWildcardCache(b);if(c&&c.has(a))return c.get(a);var d={},e=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var f in a)if("default"!=f&&Object.prototype.hasOwnProperty.call(a,f)){var g=e?Object.getOwnPropertyDescriptor(a,f):null;g&&(g.get||g.set)?Object.defineProperty(d,f,g):d[f]=a[f]}return d.default=a,c&&c.set(a,d),d}
+"use strict";var _exportNames={KameleoonProvider:!0,IKameleoonProviderProps:!0,useData:!0,useInitialize:!0,useFeatureFlag:!0,useVisitorCode:!0,IUseData:!0,IUseInitialize:!0,IUseFeatureFlag:!0,IUseVisitorCode:!0,useKameleoon:!0,KameleoonContext:!0,createClient:!0};var _javascriptSdk=require("@kameleoon/javascript-sdk");Object.defineProperty(exports,"__esModule",{value:!0});Object.defineProperty(exports,"IKameleoonProviderProps",{enumerable:!0,get:function(){return _KameleoonProvider.IKameleoonProviderProps}}),Object.defineProperty(exports,"IUseData",{enumerable:!0,get:function(){return _useData2.default}}),Object.defineProperty(exports,"IUseFeatureFlag",{enumerable:!0,get:function(){return _useFeatureFlag2.default}}),Object.defineProperty(exports,"IUseInitialize",{enumerable:!0,get:function(){return _useInitialize2.default}}),Object.defineProperty(exports,"IUseVisitorCode",{enumerable:!0,get:function(){return _useVisitorCode2.default}}),Object.defineProperty(exports,"KameleoonContext",{enumerable:!0,get:function(){return _KameleoonContext.KameleoonContext}}),Object.defineProperty(exports,"KameleoonProvider",{enumerable:!0,get:function(){return _KameleoonProvider.default}}),Object.defineProperty(exports,"createClient",{enumerable:!0,get:function(){return _createClient.createClient}}),Object.defineProperty(exports,"useData",{enumerable:!0,get:function(){return _useData.useData}}),Object.defineProperty(exports,"useFeatureFlag",{enumerable:!0,get:function(){return _useFeatureFlag.useFeatureFlag}}),Object.defineProperty(exports,"useInitialize",{enumerable:!0,get:function(){return _useInitialize.useInitialize}}),Object.defineProperty(exports,"useKameleoon",{enumerable:!0,get:function(){return _useKameleoon.useKameleoon}}),Object.defineProperty(exports,"useVisitorCode",{enumerable:!0,get:function(){return _useVisitorCode.useVisitorCode}});Object.keys(_javascriptSdk).forEach(function(a){"default"===a||"__esModule"===a||Object.prototype.hasOwnProperty.call(_exportNames,a)||a in exports&&exports[a]===_javascriptSdk[a]||Object.defineProperty(exports,a,{enumerable:!0,get:function(){return _javascriptSdk[a]}})});var _KameleoonProvider=_interopRequireWildcard(require("./KameleoonProvider")),_useData=require("./useData"),_useInitialize=require("./useInitialize"),_useFeatureFlag=require("./useFeatureFlag"),_useVisitorCode=require("./useVisitorCode"),_useData2=_interopRequireDefault(require("./interfaces/useData")),_useInitialize2=_interopRequireDefault(require("./interfaces/useInitialize")),_useFeatureFlag2=_interopRequireDefault(require("./interfaces/useFeatureFlag")),_useVisitorCode2=_interopRequireDefault(require("./interfaces/useVisitorCode")),_useKameleoon=require("./useKameleoon"),_KameleoonContext=require("./KameleoonContext"),_createClient=require("./createClient");function _interopRequireDefault(a){return a&&a.__esModule?a:{default:a}}function _getRequireWildcardCache(a){if("function"!=typeof WeakMap)return null;var b=new WeakMap,c=new WeakMap;return(_getRequireWildcardCache=function(a){return a?c:b})(a)}function _interopRequireWildcard(b,c){if(!c&&b&&b.__esModule)return b;if(null===b||"object"!=typeof b&&"function"!=typeof b)return{default:b};var d=_getRequireWildcardCache(c);if(d&&d.has(b))return d.get(b);var e={__proto__:null},f=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var a in b)if("default"!=a&&Object.prototype.hasOwnProperty.call(b,a)){var g=f?Object.getOwnPropertyDescriptor(b,a):null;g&&(g.get||g.set)?Object.defineProperty(e,a,g):e[a]=b[a]}return e.default=b,d&&d.set(b,e),e}
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"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  FeatureFlagType,\n  KameleoonDataType,\n  ApplicationVersion,\n  KameleoonException,\n  KameleoonStorageKey,\n  FeatureVariableResultType,\n  ApplicationVersionDataType,\n  RemoteVisitorDataParamsType,\n} from '@kameleoon/javascript-sdk-core';\nexport type { SDKParameters } from './types';\nexport {\n  default as KameleoonProvider,\n  IKameleoonProviderProps,\n} from './KameleoonProvider';\nexport { KameleoonContext } from './KameleoonContext';\nexport { useKameleoon } from './useKameleoon';\nexport { createClient } from './kameleoonClient';\nexport { useInitialize, IInitializeHookResult } from './useInitialize';\nexport { useFeatureFlags, IFeatureFlagsHookResult } from './useFeatureFlags';\nexport { useRemoteData, IRemoteDataHookResult } from './useRemoteData';\nexport {\n  useRemoteVisitorData,\n  IRemoteVisitorDataHookResult,\n} from './useRemoteVisitorData';\nexport { useAddData, IAddDataHookResult } from './useAddData';\nexport { useFlush, IFlushHookResult } from './useFlush';\nexport {\n  useReactVisitorCode,\n  IReactVisitorCodeHookResult,\n} from './useReactVisitorCode';\nexport {\n  useReactNativeVisitorCode,\n  IReactNativeVisitorCodeHookResult,\n} from './useReactNativeVisitorCode';\nexport {\n  useBrowserVisitorCode,\n  IBrowserVisitorCodeHookResult,\n} from './useBrowserVisitorCode';\nexport {\n  useNativeVisitorCode,\n  INativeVisitorCodeHookResult,\n} from './useNativeVisitorCode';\nexport {\n  useVisitorFeatureFlags,\n  IVisitorFeatureFlagsHookResult,\n} from './useVisitorFeatureFlags';\nexport {\n  useFeatureFlagVariationKey,\n  IFeatureFlagVariationKeyHookResult,\n} from './useFeatureFlagVariationKey';\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  useFeatureVariables,\n  IFeatureVariablesHookResult,\n} from './useFeatureVariables';\nexport {\n  useVisitorWarehouseAudience,\n  IVisitorWarehouseAudienceHookResult,\n} from './useVisitorWarehouseAudience';\nexport {\n  useTrackConversion,\n  ITrackConversionHookResult,\n} from './useTrackConversion';\nexport {\n  useConfigurationUpdate,\n  IConfigurationUpdateHookResult,\n} from './useConfigurationUpdate';\nexport {\n  useSetLegalConsent,\n  ISetLegalConsentHookResult,\n} from './useSetLegalConsent';\n"],"mappings":""}
+{"version":3,"file":"index.js","names":["_javascriptSdk","require","Object","defineProperty","exports","value","enumerable","get","_KameleoonProvider","IKameleoonProviderProps","_useData2","default","_useFeatureFlag2","_useInitialize2","_useVisitorCode2","_KameleoonContext","KameleoonContext","_createClient","createClient","_useData","useData","_useFeatureFlag","useFeatureFlag","_useInitialize","useInitialize","_useKameleoon","useKameleoon","_useVisitorCode","useVisitorCode","keys","forEach","a","prototype","hasOwnProperty","call","_exportNames","_interopRequireWildcard","_interopRequireDefault","__esModule","_getRequireWildcardCache","WeakMap","b","c","d","has","e","__proto__","f","getOwnPropertyDescriptor","g","set"],"sources":["../src/index.ts"],"sourcesContent":["export * from '@kameleoon/javascript-sdk';\nexport {\n  default as KameleoonProvider,\n  IKameleoonProviderProps,\n} from './KameleoonProvider';\nexport { useData } from './useData';\nexport { useInitialize } from './useInitialize';\nexport { useFeatureFlag } from './useFeatureFlag';\nexport { useVisitorCode } from './useVisitorCode';\nexport { default as IUseData } from './interfaces/useData';\nexport { default as IUseInitialize } from './interfaces/useInitialize';\nexport { default as IUseFeatureFlag } from './interfaces/useFeatureFlag';\nexport { default as IUseVisitorCode } from './interfaces/useVisitorCode';\nexport { useKameleoon } from './useKameleoon';\nexport { KameleoonContext } from './KameleoonContext';\nexport { createClient } from './createClient';\n"],"mappings":"wQAAA,IAAAA,cAAA,CAAAC,OAAA,8BAA0CC,MAAA,CAAAC,cAAA,CAAAC,OAAA,eAAAC,KAAA,MAAAH,MAAA,CAAAC,cAAA,CAAAC,OAAA,4BAAAE,UAAA,IAAAC,GAAA,SAAAA,CAAA,SAAAC,kBAAA,CAAAC,uBAAA,IAAAP,MAAA,CAAAC,cAAA,CAAAC,OAAA,aAAAE,UAAA,IAAAC,GAAA,SAAAA,CAAA,SAAAG,SAAA,CAAAC,OAAA,IAAAT,MAAA,CAAAC,cAAA,CAAAC,OAAA,oBAAAE,UAAA,IAAAC,GAAA,SAAAA,CAAA,SAAAK,gBAAA,CAAAD,OAAA,IAAAT,MAAA,CAAAC,cAAA,CAAAC,OAAA,mBAAAE,UAAA,IAAAC,GAAA,SAAAA,CAAA,SAAAM,eAAA,CAAAF,OAAA,IAAAT,MAAA,CAAAC,cAAA,CAAAC,OAAA,oBAAAE,UAAA,IAAAC,GAAA,SAAAA,CAAA,SAAAO,gBAAA,CAAAH,OAAA,IAAAT,MAAA,CAAAC,cAAA,CAAAC,OAAA,qBAAAE,UAAA,IAAAC,GAAA,SAAAA,CAAA,SAAAQ,iBAAA,CAAAC,gBAAA,IAAAd,MAAA,CAAAC,cAAA,CAAAC,OAAA,sBAAAE,UAAA,IAAAC,GAAA,SAAAA,CAAA,SAAAC,kBAAA,CAAAG,OAAA,IAAAT,MAAA,CAAAC,cAAA,CAAAC,OAAA,iBAAAE,UAAA,IAAAC,GAAA,SAAAA,CAAA,SAAAU,aAAA,CAAAC,YAAA,IAAAhB,MAAA,CAAAC,cAAA,CAAAC,OAAA,YAAAE,UAAA,IAAAC,GAAA,SAAAA,CAAA,SAAAY,QAAA,CAAAC,OAAA,IAAAlB,MAAA,CAAAC,cAAA,CAAAC,OAAA,mBAAAE,UAAA,IAAAC,GAAA,SAAAA,CAAA,SAAAc,eAAA,CAAAC,cAAA,IAAApB,MAAA,CAAAC,cAAA,CAAAC,OAAA,kBAAAE,UAAA,IAAAC,GAAA,SAAAA,CAAA,SAAAgB,cAAA,CAAAC,aAAA,IAAAtB,MAAA,CAAAC,cAAA,CAAAC,OAAA,iBAAAE,UAAA,IAAAC,GAAA,SAAAA,CAAA,SAAAkB,aAAA,CAAAC,YAAA,IAAAxB,MAAA,CAAAC,cAAA,CAAAC,OAAA,mBAAAE,UAAA,IAAAC,GAAA,SAAAA,CAAA,SAAAoB,eAAA,CAAAC,cAAA,IAAA1B,MAAA,CAAA2B,IAAA,CAAA7B,cAAA,EAAA8B,OAAA,UAAAC,CAAA,cAAAA,CAAA,iBAAAA,CAAA,EAAA7B,MAAA,CAAA8B,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAC,YAAA,CAAAJ,CAAA,GAAAA,CAAA,IAAA3B,OAAA,EAAAA,OAAA,CAAA2B,CAAA,IAAA/B,cAAA,CAAA+B,CAAA,GAAA7B,MAAA,CAAAC,cAAA,CAAAC,OAAA,CAAA2B,CAAA,EAAAzB,UAAA,IAAAC,GAAA,SAAAA,CAAA,SAAAP,cAAA,CAAA+B,CAAA,WAAAvB,kBAAA,CAAA4B,uBAAA,CAAAnC,OAAA,yBAAAkB,QAAA,CAAAlB,OAAA,cAAAsB,cAAA,CAAAtB,OAAA,oBAAAoB,eAAA,CAAApB,OAAA,qBAAA0B,eAAA,CAAA1B,OAAA,qBAAAS,SAAA,CAAA2B,sBAAA,CAAApC,OAAA,0BAAAY,eAAA,CAAAwB,sBAAA,CAAApC,OAAA,gCAAAW,gBAAA,CAAAyB,sBAAA,CAAApC,OAAA,iCAAAa,gBAAA,CAAAuB,sBAAA,CAAApC,OAAA,iCAAAwB,aAAA,CAAAxB,OAAA,mBAAAc,iBAAA,CAAAd,OAAA,uBAAAgB,aAAA,CAAAhB,OAAA,4BAAAoC,uBAAAN,CAAA,SAAAA,CAAA,EAAAA,CAAA,CAAAO,UAAA,CAAAP,CAAA,EAAApB,OAAA,CAAAoB,CAAA,WAAAQ,yBAAAR,CAAA,wBAAAS,OAAA,iBAAAC,CAAA,KAAAD,OAAA,CAAAE,CAAA,KAAAF,OAAA,QAAAD,wBAAA,SAAAA,CAAAR,CAAA,SAAAA,CAAA,CAAAW,CAAA,CAAAD,CAAA,GAAAV,CAAA,WAAAK,wBAAAK,CAAA,CAAAC,CAAA,MAAAA,CAAA,EAAAD,CAAA,EAAAA,CAAA,CAAAH,UAAA,QAAAG,CAAA,WAAAA,CAAA,mBAAAA,CAAA,qBAAAA,CAAA,QAAA9B,OAAA,CAAA8B,CAAA,MAAAE,CAAA,CAAAJ,wBAAA,CAAAG,CAAA,KAAAC,CAAA,EAAAA,CAAA,CAAAC,GAAA,CAAAH,CAAA,SAAAE,CAAA,CAAApC,GAAA,CAAAkC,CAAA,MAAAI,CAAA,EAAAC,SAAA,OAAAC,CAAA,CAAA7C,MAAA,CAAAC,cAAA,EAAAD,MAAA,CAAA8C,wBAAA,SAAAjB,CAAA,IAAAU,CAAA,eAAAV,CAAA,EAAA7B,MAAA,CAAA8B,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAO,CAAA,CAAAV,CAAA,OAAAkB,CAAA,CAAAF,CAAA,CAAA7C,MAAA,CAAA8C,wBAAA,CAAAP,CAAA,CAAAV,CAAA,OAAAkB,CAAA,GAAAA,CAAA,CAAA1C,GAAA,EAAA0C,CAAA,CAAAC,GAAA,EAAAhD,MAAA,CAAAC,cAAA,CAAA0C,CAAA,CAAAd,CAAA,CAAAkB,CAAA,EAAAJ,CAAA,CAAAd,CAAA,EAAAU,CAAA,CAAAV,CAAA,SAAAc,CAAA,CAAAlC,OAAA,CAAA8B,CAAA,CAAAE,CAAA,EAAAA,CAAA,CAAAO,GAAA,CAAAT,CAAA,CAAAI,CAAA,EAAAA,CAAA"}

package/dist/interfaces/useData.d.ts

@@ -0,0 +1,80 @@
+import { CustomData, GetVisitorWarehouseAudienceParamsType, JSONType, KameleoonDataType, RemoteVisitorDataParamsType, TrackConversionParamsType } from '@kameleoon/javascript-sdk';
+export default interface IUseData {
+    /**
+     * 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.
+     *
+     * @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length.
+     * @param {KameleoonDataType[]} data - number of instances of any type of `KameleoonData`, can be added solely in array or as a sequential arguments.
+     * @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.VisitorCodeMaxLength` The visitor code length was exceeded.
+     * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty
+     * - `KameleoonException.StorageWrite` Couldn't update storage data.
+     * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.
+     */
+    addData: (visitorCode: string, ...data: KameleoonDataType[]) => void;
+    /**
+     * Takes visitor associated kameleoon data and sends the data tracking request with collected data sent data is removed from `KameleoonClient` instance but not from the storage for correct targeting checks.
+     * If no visitor is passed, then data for all visitors is sent and removed from `KameleoonClient` instance. Moreover, regardless of visitor code input
+     * execution starts with sending all previously failed tracking requests which were stored locally during the offline mode and then proceeds further.
+     *
+     * @param {string | undefined} visitorCode - unique visitor identification string, can't exceed 255 characters length.
+     * @param {boolean | undefined} isUniqueIdentifier - an optional parameter for specifying if the visitorCode is a unique identifier, default value is `false`
+     * @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded
+     * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty
+     * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.
+     */
+    flush: (visitorCode?: string, isUniqueIdentifier?: boolean) => void;
+    /**
+     * Creates and adds `Conversion` data to the visitor with specified parameters and executes `flushData`. Note: it's a helper method for the quick and convenient conversion tracking, however creating and adding `Conversion` manually allows more flexible `Conversion` with `negative` parameter.
+     *
+     * @param {TrackConversionParamsType} params - `visitorCode`, `goalId`, `revenue` and `isUniqueIdentifier` parameters for data tracking.
+     * @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.VisitorCodeMaxLength` The visitor code length was exceeded.
+     * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty
+     * - `KameleoonException.StorageWrite` Couldn't update storage data.
+     */
+    trackConversion: (params: TrackConversionParamsType) => void;
+    /**
+     * Returns a data which is stored for specified siteCode on a remote Kameleoon server.
+     *
+     * @param {string} key - unique key that the data you try to get is associated with.
+     * @returns {Promise<JSONType>} promise with retrieving data for specific key.
+     * @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.RemoteData` - Couldn't retrieve data from Kameleoon server.
+     */
+    getRemoteData: (key: string) => Promise<JSONType>;
+    /**
+     * An asynchronous method for retrieving custom data for the latest visit of `visitorCode` from Kameleoon Data API and optionally adding it to the storage so that other methods could decide whether the current visitor is targeted or not.
+     *
+     * @param {RemoteVisitorDataParamsType} remoteVisitorDataParameters - `visitorCode`, `shouldAddData` and `filters` parameters
+     * @returns {KameleoonDataType[]} promise resolved to an array of `KameleoonData` instances
+     * @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded
+     * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty
+     * - `KameleoonException.RemoteData` - Couldn't retrieve data from Kameleoon server
+     * - `KameleoonException.VisitAmount` - Visit amount must be a number between 1 and 25
+     * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call
+     */
+    getRemoteVisitorData: ({ visitorCode, shouldAddData, filters, }: RemoteVisitorDataParamsType) => Promise<KameleoonDataType[]>;
+    /**
+     * An asynchronous method that returns a `CustomData` instance, containing data associated with a visitor's warehouse audiences
+     * which is stored for specified visitorCode on a remote Kameleoon server
+     * Retrieved data will be added to storage under the specified `customDataIndex`
+     *
+     * @param {GetVisitorWarehouseAudienceParamsType} parameters - an object with parameters of a type `GetVisitorWarehouseAudienceParamsType`, see the type for details
+     *
+     * @returns {Promise<CustomData | null>} `Promise` containing an instance of `CustomData` containing data associated with a visitor's warehouse audiences or `null` if the data was retrieved successfully but nothing was found under the specified `warehouseKey`
+     * @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded
+     * - `KameleoonException.VisitorCodeEmpty` - The visitor code is empty
+     * - `KameleoonException.RemoteData` - Couldn't retrieve data from Kameleoon server
+     */
+    getVisitorWarehouseAudience: ({ visitorCode, customDataIndex, warehouseKey, }: GetVisitorWarehouseAudienceParamsType) => Promise<CustomData | null>;
+}

package/dist/interfaces/useData.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=useData.js.map

package/dist/interfaces/useData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useData.js","names":[],"sources":["../../src/interfaces/useData.ts"],"sourcesContent":["import {\n  CustomData,\n  GetVisitorWarehouseAudienceParamsType,\n  JSONType,\n  KameleoonDataType,\n  RemoteVisitorDataParamsType,\n  TrackConversionParamsType,\n} from '@kameleoon/javascript-sdk';\n\nexport default interface IUseData {\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.VisitorCodeEmpty` The visitor code is empty\n   * - `KameleoonException.StorageWrite` Couldn't update storage data.\n   * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.\n   */\n  addData: (visitorCode: string, ...data: KameleoonDataType[]) => void;\n  /**\n   * Takes visitor associated kameleoon data and sends the data tracking request with collected data sent data is removed from `KameleoonClient` instance but not from the storage for correct targeting checks.\n   * If no visitor is passed, then data for all visitors is sent and removed from `KameleoonClient` instance. Moreover, regardless of visitor code input\n   * execution starts with sending all previously failed tracking requests which were stored locally during the offline mode and then proceeds further.\n   *\n   * @param {string | undefined} visitorCode - unique visitor identification string, can't exceed 255 characters length.\n   * @param {boolean | undefined} isUniqueIdentifier - an optional parameter for specifying if the visitorCode is a unique identifier, default value is `false`\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded\n   * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty\n   * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.\n   */\n  flush: (visitorCode?: string, isUniqueIdentifier?: boolean) => void;\n  /**\n   * Creates and adds `Conversion` data to the visitor with specified parameters and executes `flushData`. Note: it's a helper method for the quick and convenient conversion tracking, however creating and adding `Conversion` manually allows more flexible `Conversion` with `negative` parameter.\n   *\n   * @param {TrackConversionParamsType} params - `visitorCode`, `goalId`, `revenue` and `isUniqueIdentifier` parameters for data tracking.\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.VisitorCodeMaxLength` The visitor code length was exceeded.\n   * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty\n   * - `KameleoonException.StorageWrite` Couldn't update storage data.\n   */\n  trackConversion: (params: TrackConversionParamsType) => void;\n  /**\n   * Returns a data which is stored for specified siteCode on a remote Kameleoon server.\n   *\n   * @param {string} key - unique key that the data you try to get is associated with.\n   * @returns {Promise<JSONType>} promise with retrieving data for specific key.\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.RemoteData` - Couldn't retrieve data from Kameleoon server.\n   */\n  getRemoteData: (key: string) => Promise<JSONType>;\n  /**\n   * An asynchronous method for retrieving custom data for the latest visit of `visitorCode` from Kameleoon Data API and optionally adding it to the storage so that other methods could decide whether the current visitor is targeted or not.\n   *\n   * @param {RemoteVisitorDataParamsType} remoteVisitorDataParameters - `visitorCode`, `shouldAddData` and `filters` parameters\n   * @returns {KameleoonDataType[]} promise resolved to an array of `KameleoonData` instances\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded\n   * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty\n   * - `KameleoonException.RemoteData` - Couldn't retrieve data from Kameleoon server\n   * - `KameleoonException.VisitAmount` - Visit amount must be a number between 1 and 25\n   * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call\n   */\n  getRemoteVisitorData: ({\n    visitorCode,\n    shouldAddData,\n    filters,\n  }: RemoteVisitorDataParamsType) => Promise<KameleoonDataType[]>;\n  /**\n   * An asynchronous method that returns a `CustomData` instance, containing data associated with a visitor's warehouse audiences\n   * which is stored for specified visitorCode on a remote Kameleoon server\n   * Retrieved data will be added to storage under the specified `customDataIndex`\n   *\n   * @param {GetVisitorWarehouseAudienceParamsType} parameters - an object with parameters of a type `GetVisitorWarehouseAudienceParamsType`, see the type for details\n   *\n   * @returns {Promise<CustomData | null>} `Promise` containing an instance of `CustomData` containing data associated with a visitor's warehouse audiences or `null` if the data was retrieved successfully but nothing was found under the specified `warehouseKey`\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded\n   * - `KameleoonException.VisitorCodeEmpty` - The visitor code is empty\n   * - `KameleoonException.RemoteData` - Couldn't retrieve data from Kameleoon server\n   */\n  getVisitorWarehouseAudience: ({\n    visitorCode,\n    customDataIndex,\n    warehouseKey,\n  }: GetVisitorWarehouseAudienceParamsType) => Promise<CustomData | null>;\n}\n"],"mappings":""}

package/dist/interfaces/useFeatureFlag.d.ts

@@ -0,0 +1,101 @@
+import { FeatureFlagType, FeatureFlagVariableType, FeatureVariableResultType, GetFeatureFlagVariableParamsType } from '@kameleoon/javascript-sdk';
+export default interface IUseFeatureFlag {
+    /**
+     * Indicates whether the visitor with `visitorCode` has `featureKey` active for him, this method includes targeting check, finding the according variation exposed to the visitor and saving it to storage along with sending tracking request.
+     *
+     * @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length.
+     * @param {string} featureKey - a unique key for feature flag.
+     * @returns {boolean} a boolean indicator of whether the feature flag with `featureKey` is active for visitor with `visitorCode`.
+     * @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded.
+     * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty
+     * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.
+     * - `KameleoonException.FeatureFlagConfigurationNotFound` - No feature flag was found for provided `featureKey`.
+     * - `KameleoonException.DataInconsistency` - Allocated variation was found but there is no feature flag with according `featureKey`.
+     * - `KameleoonException.NotTargeted` - Current visitor is not targeted.
+     */
+    isFeatureFlagActive: (visitorCode: string, featureKey: string) => boolean;
+    /**
+     * Returns variation key for the visitor under `visitorCode` in the found feature flag, this method includes targeting check, finding the according variation exposed to the visitor and saving it to storage along with sending tracking request.
+     *
+     * @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length.
+     * @param {string} featureKey - a unique key for feature flag.
+     * @returns {string}  a string containing variable key for the allocated feature flag variation for the provided visitor.
+     * @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded.
+     * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty
+     * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.
+     * - `KameleoonException.FeatureFlagConfigurationNotFound` - No feature flag was found for provided `featureKey`.
+     * - `KameleoonException.NotTargeted` - Current visitor is not targeted.
+     */
+    getFeatureFlagVariationKey: (visitorCode: string, featureKey: string) => string;
+    /**
+     * Returns a variable for the visitor under `visitorCode` in the found feature flag, this method includes targeting check, finding the according variation exposed to the visitor and saving it to storage along with sending tracking request.
+     *
+     * @param {GetFeatureFlagVariableParamsType} params - `visitorCode`, `featureKey` and `variableKey` parameters to return variable.
+     * @return {FeatureFlagVariableType} a variable object containing `type` and `value` fields. You can check the `type` field against `VariableType` enum. For example, if the `type` is `VariableType.BOOLEAN` then `value` will be a `boolean` type.
+     * @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded.
+     * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty
+     * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.
+     * - `KameleoonException.FeatureFlagConfigurationNotFound` - No feature flag was found for provided `featureKey`.
+     * - `KameleoonException.FeatureFlagVariableNotFound` - No feature variable was found for provided `visitorCode` and `variableKey`
+     * - `KameleoonException.NotTargeted` - Current visitor is not targeted.
+     * - `KameleoonException.JSONParse` - Couldn't pass JSON value.
+     * - `KameleoonException.NumberParse` - Couldn't pass Number value.
+     */
+    getFeatureFlagVariable: (params: GetFeatureFlagVariableParamsType) => FeatureFlagVariableType;
+    /**
+     * Returns a list of feature flags that the visitor with `visitorCode` that is targeted by and that are *active* for the visitor (visitor  will have one of the variations allocated).
+     *
+     * @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length.
+     * @returns {FeatureFlagType[]} a list of all feature flags items with `id` and `key` fields.
+     * @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded.
+     * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty
+     * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.
+     * - `KameleoonException.NotTargeted` - Current visitor is not targeted.
+     */
+    getVisitorFeatureFlags: (visitorCode: string) => FeatureFlagType[];
+    /**
+     * Returns a list of feature flags stored in the client configuration.
+     *
+     * @returns {FeatureFlagType[]} a list of all feature flags items with `id` and `key` fields.
+     * @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.
+     */
+    getFeatureFlags: () => FeatureFlagType[];
+    /**
+     * Returns a list of variables for the visitor under `visitorCode` in the found feature flag, this method includes targeting check, finding the according variation exposed to the visitor and saving it to storage along with sending tracking request.
+     *
+     * @param {string} visitorCode - a unique visitor identifier, shouldn't exceed 255 characters.
+     * @param {string} featureKey - a unique key for feature flag.
+     * @return {FeatureVariableResultType[]} a list of variable objects containing `key`, `type` and `value` fields. You can check the `type` field against `VariableType` enum. For example, if the `type` is `VariableType.BOOLEAN` then `value` will be a `boolean` type.
+     * @throws `KameleoonError` with one of the following `type` s:
+     * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded
+     * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty
+     * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call
+     * - `KameleoonException.FeatureFlagConfigurationNotFound` - No feature flag was found for provided `featureKey`
+     * - `KameleoonException.FeatureFlagVariationNotFound` - No feature variation was found for provided `visitorCode` and `variationKey`
+     * - `KameleoonException.JSONParse` - Couldn't pass JSON value
+     * - `KameleoonException.NumberParse` - Couldn't pass Number value
+     */
+    getFeatureFlagVariables: (visitorCode: string, featureKey: string) => FeatureVariableResultType[];
+    /**
+     * Returns Kameleoon tracking code for the current visitor. Tracking code is built of the feature flag variations that were assigned during the last 5 seconds.
+     * See [Kameleoon Automation API](https://developers.kameleoon.com/apis/activation-api-js/api-reference#trigger-1) for the details
+     *
+     * @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length
+     * @returns {string} Kameleoon tracking code
+     * @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded
+     * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty
+     */
+    getEngineTrackingCode: (visitorCode: string) => string;
+}

package/dist/interfaces/useFeatureFlag.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=useFeatureFlag.js.map

package/dist/interfaces/useFeatureFlag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFeatureFlag.js","names":[],"sources":["../../src/interfaces/useFeatureFlag.ts"],"sourcesContent":["import {\n  FeatureFlagType,\n  FeatureFlagVariableType,\n  FeatureVariableResultType,\n  GetFeatureFlagVariableParamsType,\n} from '@kameleoon/javascript-sdk';\n\nexport default interface IUseFeatureFlag {\n  /**\n   * Indicates whether the visitor with `visitorCode` has `featureKey` active for him, this method includes targeting check, finding the according variation exposed to the visitor and saving it to storage along with sending tracking request.\n   *\n   * @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length.\n   * @param {string} featureKey - a unique key for feature flag.\n   * @returns {boolean} a boolean indicator of whether the feature flag with `featureKey` is active for visitor with `visitorCode`.\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded.\n   * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty\n   * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.\n   * - `KameleoonException.FeatureFlagConfigurationNotFound` - No feature flag was found for provided `featureKey`.\n   * - `KameleoonException.DataInconsistency` - Allocated variation was found but there is no feature flag with according `featureKey`.\n   * - `KameleoonException.NotTargeted` - Current visitor is not targeted.\n   */\n  isFeatureFlagActive: (visitorCode: string, featureKey: string) => boolean;\n  /**\n   * Returns variation key for the visitor under `visitorCode` in the found feature flag, this method includes targeting check, finding the according variation exposed to the visitor and saving it to storage along with sending tracking request.\n   *\n   * @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length.\n   * @param {string} featureKey - a unique key for feature flag.\n   * @returns {string}  a string containing variable key for the allocated feature flag variation for the provided visitor.\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded.\n   * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty\n   * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.\n   * - `KameleoonException.FeatureFlagConfigurationNotFound` - No feature flag was found for provided `featureKey`.\n   * - `KameleoonException.NotTargeted` - Current visitor is not targeted.\n   */\n  getFeatureFlagVariationKey: (\n    visitorCode: string,\n    featureKey: string,\n  ) => string;\n  /**\n   * Returns a variable for the visitor under `visitorCode` in the found feature flag, this method includes targeting check, finding the according variation exposed to the visitor and saving it to storage along with sending tracking request.\n   *\n   * @param {GetFeatureFlagVariableParamsType} params - `visitorCode`, `featureKey` and `variableKey` parameters to return variable.\n   * @return {FeatureFlagVariableType} a variable object containing `type` and `value` fields. You can check the `type` field against `VariableType` enum. For example, if the `type` is `VariableType.BOOLEAN` then `value` will be a `boolean` type.\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded.\n   * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty\n   * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.\n   * - `KameleoonException.FeatureFlagConfigurationNotFound` - No feature flag was found for provided `featureKey`.\n   * - `KameleoonException.FeatureFlagVariableNotFound` - No feature variable was found for provided `visitorCode` and `variableKey`\n   * - `KameleoonException.NotTargeted` - Current visitor is not targeted.\n   * - `KameleoonException.JSONParse` - Couldn't pass JSON value.\n   * - `KameleoonException.NumberParse` - Couldn't pass Number value.\n   */\n  getFeatureFlagVariable: (\n    params: GetFeatureFlagVariableParamsType,\n  ) => FeatureFlagVariableType;\n  /**\n   * Returns a list of feature flags that the visitor with `visitorCode` that is targeted by and that are *active* for the visitor (visitor  will have one of the variations allocated).\n   *\n   * @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length.\n   * @returns {FeatureFlagType[]} a list of all feature flags items with `id` and `key` fields.\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded.\n   * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty\n   * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.\n   * - `KameleoonException.NotTargeted` - Current visitor is not targeted.\n   */\n  getVisitorFeatureFlags: (visitorCode: string) => FeatureFlagType[];\n  /**\n   * Returns a list of feature flags stored in the client configuration.\n   *\n   * @returns {FeatureFlagType[]} a list of all feature flags items with `id` and `key` fields.\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.\n   */\n  getFeatureFlags: () => FeatureFlagType[];\n  /**\n   * Returns a list of variables for the visitor under `visitorCode` in the found feature flag, this method includes targeting check, finding the according variation exposed to the visitor and saving it to storage along with sending tracking request.\n   *\n   * @param {string} visitorCode - a unique visitor identifier, shouldn't exceed 255 characters.\n   * @param {string} featureKey - a unique key for feature flag.\n   * @return {FeatureVariableResultType[]} a list of variable objects containing `key`, `type` and `value` fields. You can check the `type` field against `VariableType` enum. For example, if the `type` is `VariableType.BOOLEAN` then `value` will be a `boolean` type.\n   * @throws `KameleoonError` with one of the following `type` s:\n   * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded\n   * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty\n   * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call\n   * - `KameleoonException.FeatureFlagConfigurationNotFound` - No feature flag was found for provided `featureKey`\n   * - `KameleoonException.FeatureFlagVariationNotFound` - No feature variation was found for provided `visitorCode` and `variationKey`\n   * - `KameleoonException.JSONParse` - Couldn't pass JSON value\n   * - `KameleoonException.NumberParse` - Couldn't pass Number value\n   */\n  getFeatureFlagVariables: (\n    visitorCode: string,\n    featureKey: string,\n  ) => FeatureVariableResultType[];\n  /**\n   * Returns Kameleoon tracking code for the current visitor. Tracking code is built of the 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   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded\n   * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty\n   */\n  getEngineTrackingCode: (visitorCode: string) => string;\n}\n"],"mappings":""}

package/dist/interfaces/useInitialize.d.ts

@@ -0,0 +1,23 @@
+export default interface IUseInitialize {
+    /**
+     *  An asynchronous method for KameleoonClient initialization by fetching Kameleoon SDK related data from server or by retrieving data from local source if data is up-to-date or update interval has not been reached.
+     *
+     * @param {boolean | undefined} useCache - optional parameter for activating SDK offline mode, if `true` is passed failed polls will not return error and will use cached data if such data is available, default value is `false`. Note: if offline mode is on, SDK will still try to retrieve the latest data.
+     *  @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.StorageWrite` Couldn't update storage data.
+     * - `KameleoonException.StorageRead` - Couldn't read storage data.
+     * - `KameleoonException.ClientConfiguration` Couldn't retrieve client configuration from Kameleoon Api.
+     * - `KameleoonException.MaximumRetriesReached` Maximum retries reached, request failed
+     */
+    initialize: () => Promise<boolean>;
+    /**
+     * Fires a callback on client configuration update. Note: this method only works for server sent events of real time update.
+     *
+     * @param {() => void} callback - callback function with no parameters that will be called upon configuration update.
+     * @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.
+     */
+    onConfigurationUpdate: (callback: () => void) => void;
+}

package/dist/interfaces/useInitialize.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=useInitialize.js.map

package/dist/interfaces/useInitialize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useInitialize.js","names":[],"sources":["../../src/interfaces/useInitialize.ts"],"sourcesContent":["export default interface IUseInitialize {\n  /**\n   *  An asynchronous method for KameleoonClient initialization by fetching Kameleoon SDK related data from server or by retrieving data from local source if data is up-to-date or update interval has not been reached.\n   *\n   * @param {boolean | undefined} useCache - optional parameter for activating SDK offline mode, if `true` is passed failed polls will not return error and will use cached data if such data is available, default value is `false`. Note: if offline mode is on, SDK will still try to retrieve the latest data.\n   *  @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.StorageWrite` Couldn't update storage data.\n   * - `KameleoonException.StorageRead` - Couldn't read storage data.\n   * - `KameleoonException.ClientConfiguration` Couldn't retrieve client configuration from Kameleoon Api.\n   * - `KameleoonException.MaximumRetriesReached` Maximum retries reached, request failed\n   */\n  initialize: () => Promise<boolean>;\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 the `kameleoonClient` completed it's `initialize` call.\n   */\n  onConfigurationUpdate: (callback: () => void) => void;\n}\n"],"mappings":""}

package/dist/{useSetLegalConsent.d.ts → interfaces/useVisitorCode.d.ts}

@@ -1,4 +1,4 @@
-export interface ISetLegalConsentHookResult {
+export default interface IUseVisitorCode {
     /**
      * Sets or updates the legal consent status for a visitor identified by their unique visitor code, affecting values in the response cookies based on the consent status.
      *
@@ -13,10 +13,15 @@ export interface ISetLegalConsentHookResult {
      * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty.
      */
     setLegalConsent: (visitorCode: string, consent: boolean) => void;
+    /**
+     * Obtains visitor code from browser cookie, if no cookie exists returns new random visitor code (or the specified default value).
+     *
+     * @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.
+     * @returns {string} result visitor code.
+     * @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded
+     * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty
+     */
+    getVisitorCode: (defaultVisitorCode?: string) => string;
 }
-/**
- * A React Hook that returns setLegalConsent function which sets or updates the legal consent status for a visitor identified by their unique visitor code, affecting values in the response cookies based on the consent status.
- *
- * @returns {ISetLegalConsentHookResult} an object containing the `setLegalConsent` function.
- */
-export declare function useSetLegalConsent(): ISetLegalConsentHookResult;

package/dist/interfaces/useVisitorCode.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=useVisitorCode.js.map

package/dist/interfaces/useVisitorCode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useVisitorCode.js","names":[],"sources":["../../src/interfaces/useVisitorCode.ts"],"sourcesContent":["export default interface IUseVisitorCode {\n  /**\n   * Sets or updates the legal consent status for a visitor identified by their unique visitor code, affecting values in the response cookies based on the consent status.\n   *\n   * @param {string} visitorCode - unique visitor identifier, shouldn't exceed 255 characters.\n   * @param {boolean} consent - a value representing the legal consent status. - 'true' indicates the\n   *        visitor has given legal consent. - 'false' indicates the visitor has withdrawn or not\n   *        provided legal consent.\n   * @returns {void}\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded.\n   * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty.\n   */\n  setLegalConsent: (visitorCode: string, consent: boolean) => void;\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 | 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   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded\n   * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty\n   */\n  getVisitorCode: (defaultVisitorCode?: string) => string;\n}\n"],"mappings":""}

package/dist/useData.d.ts

@@ -0,0 +1,13 @@
+import IUseData from './interfaces/useData';
+/**
+ * A React Hook that returns methods related to SDK data management
+ *
+ * @returns {IUseData} an object containing the following methods:
+ * - `addData`
+ * - `flush`
+ * - `trackConversion`
+ * - `getRemoteData`
+ * - `getRemoteVisitorData`
+ * - `getVisitorWarehouseAudience`
+ */
+export declare function useData(): IUseData;

package/dist/useData.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.useData=useData;var _react=require("react"),_useKameleoon=require("./useKameleoon");function useData(){const a=(0,_useKameleoon.useKameleoon)(),b=(0,_react.useCallback)(function(b){for(var c=arguments.length,d=Array(1<c?c-1:0),e=1;e<c;e++)d[e-1]=arguments[e];a.addData(b,...d)},[a]),c=(0,_react.useCallback)((b,c)=>{a.flush(b,c)},[a]),d=(0,_react.useCallback)(b=>{let{visitorCode:c,goalId:d,revenue:e,isUniqueIdentifier:f}=b;a.trackConversion({visitorCode:c,goalId:d,revenue:e,isUniqueIdentifier:f})},[a]),e=(0,_react.useCallback)(async b=>await a.getRemoteData(b),[a]),f=(0,_react.useCallback)(async b=>await a.getRemoteVisitorData(b),[a]),g=(0,_react.useCallback)(async b=>await a.getVisitorWarehouseAudience(b),[a]);return{getRemoteData:e,getRemoteVisitorData:f,getVisitorWarehouseAudience:g,trackConversion:d,addData:b,flush:c}}
+//# sourceMappingURL=useData.js.map

package/dist/useData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useData.js","names":["useData","client","useKameleoon","addData","useCallback","visitorCode","c","arguments","length","data","Array","e","flush","isUniqueIdentifier","trackConversion","b","goalId","revenue","getRemoteData","key","getRemoteVisitorData","params","getVisitorWarehouseAudience"],"sources":["../src/useData.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport {\n  CustomData,\n  GetVisitorWarehouseAudienceParamsType,\n  JSONType,\n  KameleoonDataType,\n  RemoteVisitorDataParamsType,\n  TrackConversionParamsType,\n} from '@kameleoon/javascript-sdk';\nimport { useKameleoon } from './useKameleoon';\nimport IUseData from './interfaces/useData';\n\n/**\n * A React Hook that returns methods related to SDK data management\n *\n * @returns {IUseData} an object containing the following methods:\n * - `addData`\n * - `flush`\n * - `trackConversion`\n * - `getRemoteData`\n * - `getRemoteVisitorData`\n * - `getVisitorWarehouseAudience`\n */\nexport function useData(): IUseData {\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  const flush = useCallback(\n    (visitorCode?: string, isUniqueIdentifier?: boolean): void => {\n      client.flush(visitorCode, isUniqueIdentifier);\n    },\n    [client],\n  );\n\n  const trackConversion = useCallback(\n    ({\n      visitorCode,\n      goalId,\n      revenue,\n      isUniqueIdentifier,\n    }: TrackConversionParamsType): void => {\n      client.trackConversion({\n        visitorCode,\n        goalId,\n        revenue,\n        isUniqueIdentifier,\n      });\n    },\n    [client],\n  );\n\n  const getRemoteData = useCallback(\n    async (key: string): Promise<JSONType> => {\n      return await client.getRemoteData(key);\n    },\n    [client],\n  );\n\n  const getRemoteVisitorData = useCallback(\n    async (\n      params: RemoteVisitorDataParamsType,\n    ): Promise<KameleoonDataType[]> => {\n      return await client.getRemoteVisitorData(params);\n    },\n    [client],\n  );\n\n  const getVisitorWarehouseAudience = useCallback(\n    async (\n      params: GetVisitorWarehouseAudienceParamsType,\n    ): Promise<CustomData | null> => {\n      return await client.getVisitorWarehouseAudience(params);\n    },\n    [client],\n  );\n\n  return {\n    getRemoteData,\n    getRemoteVisitorData,\n    getVisitorWarehouseAudience,\n    trackConversion,\n    addData,\n    flush,\n  };\n}\n"],"mappings":"gKAuBO,QAAS,CAAAA,OAAOA,CAAA,CAAa,MAC5B,CAAAC,CAAM,CAAG,GAAAC,0BAAY,EAAC,CAAC,CAEvBC,CAAO,CAAG,GAAAC,kBAAW,EACzB,SAACC,CAAmB,CAAyC,SAAAC,CAAA,CAAAC,SAAA,CAAAC,MAAA,CAApCC,CAAI,CAAAC,KAAA,GAAAJ,CAAA,CAAAA,CAAA,MAAAK,CAAA,GAAAA,CAAA,CAAAL,CAAA,CAAAK,CAAA,GAAJF,CAAI,CAAAE,CAAA,IAAAJ,SAAA,CAAAI,CAAA,EAC3BV,CAAM,CAACE,OAAO,CAACE,CAAW,CAAE,GAAGI,CAAI,CACrC,CAAC,CACD,CAACR,CAAM,CACT,CAAC,CAEKW,CAAK,CAAG,GAAAR,kBAAW,EACvB,CAACC,CAAoB,CAAEQ,CAA4B,GAAW,CAC5DZ,CAAM,CAACW,KAAK,CAACP,CAAW,CAAEQ,CAAkB,CAC9C,CAAC,CACD,CAACZ,CAAM,CACT,CAAC,CAEKa,CAAe,CAAG,GAAAV,kBAAW,EACjCW,CAAA,EAKuC,IALtC,CACCV,WAAW,CAAXA,CAAW,CACXW,MAAM,CAANA,CAAM,CACNC,OAAO,CAAPA,CAAO,CACPJ,kBAAkB,CAAlBA,CACyB,CAAC,CAAAE,CAAA,CAC1Bd,CAAM,CAACa,eAAe,CAAC,CACrBT,WAAW,CAAXA,CAAW,CACXW,MAAM,CAANA,CAAM,CACNC,OAAO,CAAPA,CAAO,CACPJ,kBAAkB,CAAlBA,CACF,CAAC,CACH,CAAC,CACD,CAACZ,CAAM,CACT,CAAC,CAEKiB,CAAa,CAAG,GAAAd,kBAAW,EAC/B,KAAO,CAAAe,CAAW,EACT,KAAM,CAAAlB,CAAM,CAACiB,aAAa,CAACC,CAAG,CACtC,CACD,CAAClB,CAAM,CACT,CAAC,CAEKmB,CAAoB,CAAG,GAAAhB,kBAAW,EACtC,KACE,CAAAiB,CAAmC,EAE5B,KAAM,CAAApB,CAAM,CAACmB,oBAAoB,CAACC,CAAM,CAChD,CACD,CAACpB,CAAM,CACT,CAAC,CAEKqB,CAA2B,CAAG,GAAAlB,kBAAW,EAC7C,KACE,CAAAiB,CAA6C,EAEtC,KAAM,CAAApB,CAAM,CAACqB,2BAA2B,CAACD,CAAM,CACvD,CACD,CAACpB,CAAM,CACT,CAAC,CAED,MAAO,CACLiB,aAAa,CAAbA,CAAa,CACbE,oBAAoB,CAApBA,CAAoB,CACpBE,2BAA2B,CAA3BA,CAA2B,CAC3BR,eAAe,CAAfA,CAAe,CACfX,OAAO,CAAPA,CAAO,CACPS,KAAK,CAALA,CACF,CACF"}

package/dist/useFeatureFlag.d.ts

@@ -0,0 +1,15 @@
+import IUseFeatureFlag from './interfaces/useFeatureFlag';
+/**
+ * A React Hook that returns methods related to SDK feature flag
+ * and feature experimentation management
+ *
+ * @returns {IUseFeatureFlag} an object containing the following methods:
+ * - `isFeatureFlagActive`,
+ * - `getFeatureFlagVariationKey`,
+ * - `getFeatureFlagVariable`,
+ * - `getVisitorFeatureFlags`,
+ * - `getFeatureFlags`,
+ * - `getFeatureFlagVariables`,
+ * - `getEngineTrackingCode`
+ */
+export declare function useFeatureFlag(): IUseFeatureFlag;

package/dist/useFeatureFlag.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.useFeatureFlag=useFeatureFlag;var _react=require("react"),_useKameleoon=require("./useKameleoon");function useFeatureFlag(){const a=(0,_useKameleoon.useKameleoon)(),b=(0,_react.useCallback)((b,c)=>a.isFeatureFlagActive(b,c),[a]),c=(0,_react.useCallback)((b,c)=>a.getFeatureFlagVariationKey(b,c),[a]),d=(0,_react.useCallback)(b=>{let{visitorCode:c,featureKey:d,variableKey:e}=b;return a.getFeatureFlagVariable({visitorCode:c,featureKey:d,variableKey:e})},[a]),e=(0,_react.useCallback)(b=>a.getVisitorFeatureFlags(b),[a]),f=(0,_react.useCallback)(()=>a.getFeatureFlags(),[a]),g=(0,_react.useCallback)((b,c)=>a.getFeatureFlagVariables(b,c),[a]),h=(0,_react.useCallback)(b=>a.getEngineTrackingCode(b),[a]);return{getFeatureFlags:f,isFeatureFlagActive:b,getEngineTrackingCode:h,getVisitorFeatureFlags:e,getFeatureFlagVariable:d,getFeatureFlagVariables:g,getFeatureFlagVariationKey:c}}
+//# sourceMappingURL=useFeatureFlag.js.map

package/dist/useFeatureFlag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFeatureFlag.js","names":["useFeatureFlag","client","useKameleoon","isFeatureFlagActive","useCallback","visitorCode","featureKey","getFeatureFlagVariationKey","getFeatureFlagVariable","b","variableKey","getVisitorFeatureFlags","getFeatureFlags","getFeatureFlagVariables","getEngineTrackingCode"],"sources":["../src/useFeatureFlag.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport IUseFeatureFlag from './interfaces/useFeatureFlag';\nimport { useKameleoon } from './useKameleoon';\nimport {\n  FeatureFlagType,\n  FeatureFlagVariableType,\n  FeatureVariableResultType,\n  GetFeatureFlagVariableParamsType,\n} from '@kameleoon/javascript-sdk';\n\n/**\n * A React Hook that returns methods related to SDK feature flag\n * and feature experimentation management\n *\n * @returns {IUseFeatureFlag} an object containing the following methods:\n * - `isFeatureFlagActive`,\n * - `getFeatureFlagVariationKey`,\n * - `getFeatureFlagVariable`,\n * - `getVisitorFeatureFlags`,\n * - `getFeatureFlags`,\n * - `getFeatureFlagVariables`,\n * - `getEngineTrackingCode`\n */\nexport function useFeatureFlag(): IUseFeatureFlag {\n  const client = useKameleoon();\n\n  const isFeatureFlagActive = useCallback(\n    (visitorCode: string, featureKey: string): boolean => {\n      return client.isFeatureFlagActive(visitorCode, featureKey);\n    },\n    [client],\n  );\n\n  const getFeatureFlagVariationKey = useCallback(\n    (visitorCode: string, featureKey: string): string => {\n      return client.getFeatureFlagVariationKey(visitorCode, featureKey);\n    },\n    [client],\n  );\n\n  const getFeatureFlagVariable = useCallback(\n    ({\n      visitorCode,\n      featureKey,\n      variableKey,\n    }: GetFeatureFlagVariableParamsType): FeatureFlagVariableType => {\n      return client.getFeatureFlagVariable({\n        visitorCode,\n        featureKey,\n        variableKey,\n      });\n    },\n    [client],\n  );\n\n  const getVisitorFeatureFlags = useCallback(\n    (visitorCode: string): FeatureFlagType[] => {\n      return client.getVisitorFeatureFlags(visitorCode);\n    },\n    [client],\n  );\n\n  const getFeatureFlags = useCallback((): FeatureFlagType[] => {\n    return client.getFeatureFlags();\n  }, [client]);\n\n  const getFeatureFlagVariables = useCallback(\n    (visitorCode, featureKey): FeatureVariableResultType[] => {\n      return client.getFeatureFlagVariables(visitorCode, featureKey);\n    },\n    [client],\n  );\n\n  const getEngineTrackingCode = useCallback(\n    (visitorCode: string): string => {\n      return client.getEngineTrackingCode(visitorCode);\n    },\n    [client],\n  );\n\n  return {\n    getFeatureFlags,\n    isFeatureFlagActive,\n    getEngineTrackingCode,\n    getVisitorFeatureFlags,\n    getFeatureFlagVariable,\n    getFeatureFlagVariables,\n    getFeatureFlagVariationKey,\n  };\n}\n"],"mappings":"8KAuBO,QAAS,CAAAA,cAAcA,CAAA,CAAoB,MAC1C,CAAAC,CAAM,CAAG,GAAAC,0BAAY,EAAC,CAAC,CAEvBC,CAAmB,CAAG,GAAAC,kBAAW,EACrC,CAACC,CAAmB,CAAEC,CAAkB,GAC/BL,CAAM,CAACE,mBAAmB,CAACE,CAAW,CAAEC,CAAU,CAC1D,CACD,CAACL,CAAM,CACT,CAAC,CAEKM,CAA0B,CAAG,GAAAH,kBAAW,EAC5C,CAACC,CAAmB,CAAEC,CAAkB,GAC/BL,CAAM,CAACM,0BAA0B,CAACF,CAAW,CAAEC,CAAU,CACjE,CACD,CAACL,CAAM,CACT,CAAC,CAEKO,CAAsB,CAAG,GAAAJ,kBAAW,EACxCK,CAAA,EAIiE,IAJhE,CACCJ,WAAW,CAAXA,CAAW,CACXC,UAAU,CAAVA,CAAU,CACVI,WAAW,CAAXA,CACgC,CAAC,CAAAD,CAAA,CACjC,MAAO,CAAAR,CAAM,CAACO,sBAAsB,CAAC,CACnCH,WAAW,CAAXA,CAAW,CACXC,UAAU,CAAVA,CAAU,CACVI,WAAW,CAAXA,CACF,CAAC,CACH,CAAC,CACD,CAACT,CAAM,CACT,CAAC,CAEKU,CAAsB,CAAG,GAAAP,kBAAW,EACvCC,CAAmB,EACXJ,CAAM,CAACU,sBAAsB,CAACN,CAAW,CACjD,CACD,CAACJ,CAAM,CACT,CAAC,CAEKW,CAAe,CAAG,GAAAR,kBAAW,EAAC,IAC3BH,CAAM,CAACW,eAAe,CAAC,CAC/B,CAAE,CAACX,CAAM,CAAC,CAAC,CAENY,CAAuB,CAAG,GAAAT,kBAAW,EACzC,CAACC,CAAW,CAAEC,CAAU,GACfL,CAAM,CAACY,uBAAuB,CAACR,CAAW,CAAEC,CAAU,CAC9D,CACD,CAACL,CAAM,CACT,CAAC,CAEKa,CAAqB,CAAG,GAAAV,kBAAW,EACtCC,CAAmB,EACXJ,CAAM,CAACa,qBAAqB,CAACT,CAAW,CAChD,CACD,CAACJ,CAAM,CACT,CAAC,CAED,MAAO,CACLW,eAAe,CAAfA,CAAe,CACfT,mBAAmB,CAAnBA,CAAmB,CACnBW,qBAAqB,CAArBA,CAAqB,CACrBH,sBAAsB,CAAtBA,CAAsB,CACtBH,sBAAsB,CAAtBA,CAAsB,CACtBK,uBAAuB,CAAvBA,CAAuB,CACvBN,0BAA0B,CAA1BA,CACF,CACF"}

package/dist/useInitialize.d.ts

@@ -1,20 +1,9 @@
-export interface IInitializeHookResult {
-    /**
-     *  An asynchronous method for KameleoonClient initialization by fetching Kameleoon SDK related data from server or by retrieving data from local source if data is up-to-date or update interval has not been reached.
-     *
-     * @param {boolean | undefined} useCache - optional parameter for activating SDK offline mode, if `true` is passed failed polls will not return error and will use cached data if such data is available, default value is `false`. Note: if offline mode is on, SDK will still try to retrieve the latest data.
-     *  @throws `KameleoonError` with one of the following `type` s:
-     *
-     * - `KameleoonException.StorageWrite` Couldn't update storage data.
-     * - `KameleoonException.StorageRead` - Couldn't read storage data.
-     * - `KameleoonException.ClientConfiguration` Couldn't retrieve client configuration from Kameleoon Api.
-     * - `KameleoonException.MaximumRetriesReached` Maximum retries reached, request failed
-     */
-    initialize: () => Promise<boolean>;
-}
+import IUseInitialize from './interfaces/useInitialize';
 /**
- * A React Hook that returns asynchronous `initialize` function.
+ * A React Hook that returns methods related to SDK setup and configuration
  *
- * @returns {IInitializeHookResult} an object containing the asynchronous `initialize` function.
+ * @returns {IUseInitialize} an object containing the following methods:
+ * - `initialize`
+ * - `onConfigurationUpdate`
  */
-export declare function useInitialize(): IInitializeHookResult;
+export declare function useInitialize(): IUseInitialize;