@kameleoon/javascript-sdk 1.3.3 → 1.4.1

package/dist/kameleoonClient.d.ts

@@ -5,4 +5,15 @@ import { SDKConfigurationType, KameleoonCore } from '@kameleoon/javascript-sdk-c
  * */
 export declare class KameleoonClient extends KameleoonCore {
     constructor(siteCode: string, configuration?: Partial<SDKConfigurationType>);
+    /**
+     * @method initialize - 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.
+     * @returns {Promise<boolean>} Promise resolved into boolean field indicating success or fail
+     * @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.StorageWrite` Couldn't update storage data
+     * - `KameleoonException.ClientConfiguration` Couldn't retrieve client configuration from Kameleoon Api
+     * - `KameleoonException.MaximumRetriesReached` Maximum retries reached, request failed
+     */
+    initialize(useCache?: boolean): Promise<boolean>;
 }

package/dist/kameleoonClient.js

@@ -26,11 +26,25 @@ class KameleoonClient extends _javascriptSdkCore.KameleoonCore {
         externalRequestDispatcher: requestDispatcher,
         externalPackageInfo: {
           type: _javascriptSdkCore.SDKType.JavaScript,
-          version: "1.3.3"
+          version: "1.4.1"
         }
       }
     });
   }
+
+  /**
+   * @method initialize - 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.
+   * @returns {Promise<boolean>} Promise resolved into boolean field indicating success or fail
+   * @throws `KameleoonError` with one of the following `type` s:
+   *
+   * - `KameleoonException.StorageWrite` Couldn't update storage data
+   * - `KameleoonException.ClientConfiguration` Couldn't retrieve client configuration from Kameleoon Api
+   * - `KameleoonException.MaximumRetriesReached` Maximum retries reached, request failed
+   */
+  async initialize(useCache) {
+    return super.initialize(useCache);
+  }
 }
 exports.KameleoonClient = KameleoonClient;
 //# sourceMappingURL=kameleoonClient.js.map

package/dist/kameleoonClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"kameleoonClient.js","names":["_javascriptSdkCore","require","_storage","_requester","_eventSource","KameleoonClient","KameleoonCore","constructor","siteCode","configuration","storage","StorageConstructor","eventSource","EventSourceConstructor","requestDispatcher","RequestDispatcher","internalConfiguration","externalStorage","externalEventSource","externalRequestDispatcher","externalPackageInfo","type","SDKType","JavaScript","version","exports"],"sources":["../src/kameleoonClient.ts"],"sourcesContent":["import {\n  SDKConfigurationType,\n  KameleoonCore,\n  SDKType,\n} from '@kameleoon/javascript-sdk-core';\nimport { StorageConstructor } from './storage';\nimport { RequestDispatcher } from './requester';\nimport { EventSourceConstructor } from './eventSource';\n\n/**\n * @class\n * KameleoonClient - a class for creating kameleoon client instance\n * */\nexport class KameleoonClient extends KameleoonCore {\n  constructor(siteCode: string, configuration?: Partial<SDKConfigurationType>) {\n    const storage = new StorageConstructor();\n    const eventSource = new EventSourceConstructor();\n    const requestDispatcher = new RequestDispatcher();\n\n    super({\n      siteCode,\n      configuration,\n      internalConfiguration: {\n        externalStorage: storage,\n        externalEventSource: eventSource,\n        externalRequestDispatcher: requestDispatcher,\n        externalPackageInfo: {\n          type: SDKType.JavaScript,\n          version: process.env.npm_package_version as string,\n        },\n      },\n    });\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,kBAAA,GAAAC,OAAA;AAKA,IAAAC,QAAA,GAAAD,OAAA;AACA,IAAAE,UAAA,GAAAF,OAAA;AACA,IAAAG,YAAA,GAAAH,OAAA;AAEA;AACA;AACA;AACA;AACO,MAAMI,eAAe,SAASC,gCAAa,CAAC;EACjDC,WAAWA,CAACC,QAAgB,EAAEC,aAA6C,EAAE;IAC3E,MAAMC,OAAO,GAAG,IAAIC,2BAAkB,EAAE;IACxC,MAAMC,WAAW,GAAG,IAAIC,mCAAsB,EAAE;IAChD,MAAMC,iBAAiB,GAAG,IAAIC,4BAAiB,EAAE;IAEjD,KAAK,CAAC;MACJP,QAAQ;MACRC,aAAa;MACbO,qBAAqB,EAAE;QACrBC,eAAe,EAAEP,OAAO;QACxBQ,mBAAmB,EAAEN,WAAW;QAChCO,yBAAyB,EAAEL,iBAAiB;QAC5CM,mBAAmB,EAAE;UACnBC,IAAI,EAAEC,0BAAO,CAACC,UAAU;UACxBC,OAAO;QACT;MACF;IACF,CAAC,CAAC;EACJ;AACF;AAACC,OAAA,CAAApB,eAAA,GAAAA,eAAA"}
+{"version":3,"file":"kameleoonClient.js","names":["_javascriptSdkCore","require","_storage","_requester","_eventSource","KameleoonClient","KameleoonCore","constructor","siteCode","configuration","storage","StorageConstructor","eventSource","EventSourceConstructor","requestDispatcher","RequestDispatcher","internalConfiguration","externalStorage","externalEventSource","externalRequestDispatcher","externalPackageInfo","type","SDKType","JavaScript","version","initialize","useCache","exports"],"sources":["../src/kameleoonClient.ts"],"sourcesContent":["import {\n  SDKConfigurationType,\n  KameleoonCore,\n  SDKType,\n} from '@kameleoon/javascript-sdk-core';\nimport { StorageConstructor } from './storage';\nimport { RequestDispatcher } from './requester';\nimport { EventSourceConstructor } from './eventSource';\n\n/**\n * @class\n * KameleoonClient - a class for creating kameleoon client instance\n * */\nexport class KameleoonClient extends KameleoonCore {\n  constructor(siteCode: string, configuration?: Partial<SDKConfigurationType>) {\n    const storage = new StorageConstructor();\n    const eventSource = new EventSourceConstructor();\n    const requestDispatcher = new RequestDispatcher();\n\n    super({\n      siteCode,\n      configuration,\n      internalConfiguration: {\n        externalStorage: storage,\n        externalEventSource: eventSource,\n        externalRequestDispatcher: requestDispatcher,\n        externalPackageInfo: {\n          type: SDKType.JavaScript,\n          version: process.env.npm_package_version as string,\n        },\n      },\n    });\n  }\n\n  /**\n   * @method initialize - 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   * @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   * @returns {Promise<boolean>} Promise resolved into boolean field indicating success or fail\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.StorageWrite` Couldn't update storage data\n   * - `KameleoonException.ClientConfiguration` Couldn't retrieve client configuration from Kameleoon Api\n   * - `KameleoonException.MaximumRetriesReached` Maximum retries reached, request failed\n   */\n  public async initialize(useCache?: boolean): Promise<boolean> {\n    return super.initialize(useCache);\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,kBAAA,GAAAC,OAAA;AAKA,IAAAC,QAAA,GAAAD,OAAA;AACA,IAAAE,UAAA,GAAAF,OAAA;AACA,IAAAG,YAAA,GAAAH,OAAA;AAEA;AACA;AACA;AACA;AACO,MAAMI,eAAe,SAASC,gCAAa,CAAC;EACjDC,WAAWA,CAACC,QAAgB,EAAEC,aAA6C,EAAE;IAC3E,MAAMC,OAAO,GAAG,IAAIC,2BAAkB,EAAE;IACxC,MAAMC,WAAW,GAAG,IAAIC,mCAAsB,EAAE;IAChD,MAAMC,iBAAiB,GAAG,IAAIC,4BAAiB,EAAE;IAEjD,KAAK,CAAC;MACJP,QAAQ;MACRC,aAAa;MACbO,qBAAqB,EAAE;QACrBC,eAAe,EAAEP,OAAO;QACxBQ,mBAAmB,EAAEN,WAAW;QAChCO,yBAAyB,EAAEL,iBAAiB;QAC5CM,mBAAmB,EAAE;UACnBC,IAAI,EAAEC,0BAAO,CAACC,UAAU;UACxBC,OAAO;QACT;MACF;IACF,CAAC,CAAC;EACJ;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAaC,UAAUA,CAACC,QAAkB,EAAoB;IAC5D,OAAO,KAAK,CAACD,UAAU,CAACC,QAAQ,CAAC;EACnC;AACF;AAACC,OAAA,CAAAtB,eAAA,GAAAA,eAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kameleoon/javascript-sdk",
-  "version": "1.3.3",
+  "version": "1.4.1",
   "description": "Kameleoon JavaScript SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",