@kameleoon/javascript-sdk 1.3.2 → 1.4.0

package/dist/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const NUMBER_OF_RETRIES = 3;
+export declare const DELAY_MILLISECONDS = 2000;

package/dist/constants.js

@@ -0,0 +1,11 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.NUMBER_OF_RETRIES = exports.DELAY_MILLISECONDS = void 0;
+const NUMBER_OF_RETRIES = 3;
+exports.NUMBER_OF_RETRIES = NUMBER_OF_RETRIES;
+const DELAY_MILLISECONDS = 2000;
+exports.DELAY_MILLISECONDS = DELAY_MILLISECONDS;
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","names":["NUMBER_OF_RETRIES","exports","DELAY_MILLISECONDS"],"sources":["../src/constants.ts"],"sourcesContent":["export const NUMBER_OF_RETRIES = 3;\nexport const DELAY_MILLISECONDS = 2000;\n"],"mappings":";;;;;;AAAO,MAAMA,iBAAiB,GAAG,CAAC;AAACC,OAAA,CAAAD,iBAAA,GAAAA,iBAAA;AAC5B,MAAME,kBAAkB,GAAG,IAAI;AAACD,OAAA,CAAAC,kBAAA,GAAAA,kBAAA"}

package/dist/kameleoonClient.d.ts

@@ -1,8 +1,19 @@
-import { KameleoonCore, SDKConfigurationType } from '@kameleoon/javascript-sdk-core';
+import { SDKConfigurationType, KameleoonCore } from '@kameleoon/javascript-sdk-core';
 /**
  * @class
  * KameleoonClient - a class for creating kameleoon client instance
  * */
 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

@@ -5,8 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.KameleoonClient = void 0;
 var _javascriptSdkCore = require("@kameleoon/javascript-sdk-core");
-var _storage = require("./storage");
 var _requester = require("./requester");
+var _storage = require("./storage");
 var _eventSource = require("./eventSource");
 /**
  * @class
@@ -26,11 +26,25 @@ class KameleoonClient extends _javascriptSdkCore.KameleoonCore {
         externalRequestDispatcher: requestDispatcher,
         externalPackageInfo: {
           type: _javascriptSdkCore.SDKType.JavaScript,
-          version: "1.3.2"
+          version: "1.4.0"
         }
       }
     });
   }
+
+  /**
+   * @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  KameleoonCore,\n  SDKConfigurationType,\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","_requester","_storage","_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 { RequestDispatcher } from './requester';\nimport { StorageConstructor } from './storage';\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,UAAA,GAAAD,OAAA;AACA,IAAAE,QAAA,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/dist/requester.d.ts

@@ -1,5 +1,6 @@
 import { JSONType, TrackParametersType, IExternalRequestDispatcher } from '@kameleoon/javascript-sdk-core';
 export declare class RequestDispatcher implements IExternalRequestDispatcher {
     track({ url, headers, body, }: TrackParametersType): Promise<boolean>;
-    get(url: string): Promise<JSONType>;
+    getClientConfiguration(url: string): Promise<JSONType>;
+    getRemoteData(url: string): Promise<JSONType>;
 }

package/dist/requester.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.RequestDispatcher = void 0;
 var _javascriptSdkCore = require("@kameleoon/javascript-sdk-core");
+var _constants = require("./constants");
 class RequestDispatcher {
   async track({
     url,
@@ -18,7 +19,25 @@ class RequestDispatcher {
     });
     return response.ok;
   }
-  async get(url) {
+  async getClientConfiguration(url) {
+    for (let i = 1; i <= _constants.NUMBER_OF_RETRIES; i++) {
+      try {
+        const response = await fetch(url, {
+          method: _javascriptSdkCore.HttpMethod.Get
+        });
+        if (response.status !== 504) {
+          return response.json();
+        }
+      } catch (err) {
+        throw new _javascriptSdkCore.KameleoonError(_javascriptSdkCore.KameleoonException.ClientConfiguration);
+      }
+      if (i < _constants.NUMBER_OF_RETRIES) {
+        await new Promise(resolve => setTimeout(resolve, _constants.DELAY_MILLISECONDS));
+      }
+    }
+    throw new _javascriptSdkCore.KameleoonError(_javascriptSdkCore.KameleoonException.MaximumRetriesReached);
+  }
+  async getRemoteData(url) {
     const response = await fetch(url, {
       method: _javascriptSdkCore.HttpMethod.Get
     });

package/dist/requester.js.map

@@ -1 +1 @@
-{"version":3,"file":"requester.js","names":["_javascriptSdkCore","require","RequestDispatcher","track","url","headers","body","response","fetch","method","HttpMethod","Post","ok","get","Get","json","exports"],"sources":["../src/requester.ts"],"sourcesContent":["import {\n  JSONType,\n  HttpMethod,\n  TrackParametersType,\n  IExternalRequestDispatcher,\n} from '@kameleoon/javascript-sdk-core';\n\nexport class RequestDispatcher implements IExternalRequestDispatcher {\n  public async track({\n    url,\n    headers,\n    body,\n  }: TrackParametersType): Promise<boolean> {\n    const response = await fetch(url, {\n      method: HttpMethod.Post,\n      headers,\n      body,\n    });\n\n    return response.ok;\n  }\n\n  public async get(url: string): Promise<JSONType> {\n    const response = await fetch(url, {\n      method: HttpMethod.Get,\n    });\n\n    return response.json();\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,kBAAA,GAAAC,OAAA;AAOO,MAAMC,iBAAiB,CAAuC;EACnE,MAAaC,KAAKA,CAAC;IACjBC,GAAG;IACHC,OAAO;IACPC;EACmB,CAAC,EAAoB;IACxC,MAAMC,QAAQ,GAAG,MAAMC,KAAK,CAACJ,GAAG,EAAE;MAChCK,MAAM,EAAEC,6BAAU,CAACC,IAAI;MACvBN,OAAO;MACPC;IACF,CAAC,CAAC;IAEF,OAAOC,QAAQ,CAACK,EAAE;EACpB;EAEA,MAAaC,GAAGA,CAACT,GAAW,EAAqB;IAC/C,MAAMG,QAAQ,GAAG,MAAMC,KAAK,CAACJ,GAAG,EAAE;MAChCK,MAAM,EAAEC,6BAAU,CAACI;IACrB,CAAC,CAAC;IAEF,OAAOP,QAAQ,CAACQ,IAAI,EAAE;EACxB;AACF;AAACC,OAAA,CAAAd,iBAAA,GAAAA,iBAAA"}
+{"version":3,"file":"requester.js","names":["_javascriptSdkCore","require","_constants","RequestDispatcher","track","url","headers","body","response","fetch","method","HttpMethod","Post","ok","getClientConfiguration","i","NUMBER_OF_RETRIES","Get","status","json","err","KameleoonError","KameleoonException","ClientConfiguration","Promise","resolve","setTimeout","DELAY_MILLISECONDS","MaximumRetriesReached","getRemoteData","exports"],"sources":["../src/requester.ts"],"sourcesContent":["import {\n  JSONType,\n  HttpMethod,\n  TrackParametersType,\n  IExternalRequestDispatcher,\n  KameleoonError,\n  KameleoonException,\n} from '@kameleoon/javascript-sdk-core';\nimport { DELAY_MILLISECONDS, NUMBER_OF_RETRIES } from './constants';\n\nexport class RequestDispatcher implements IExternalRequestDispatcher {\n  public async track({\n    url,\n    headers,\n    body,\n  }: TrackParametersType): Promise<boolean> {\n    const response = await fetch(url, {\n      method: HttpMethod.Post,\n      headers,\n      body,\n    });\n\n    return response.ok;\n  }\n\n  public async getClientConfiguration(url: string): Promise<JSONType> {\n    for (let i = 1; i <= NUMBER_OF_RETRIES; i++) {\n      try {\n        const response = await fetch(url, {\n          method: HttpMethod.Get,\n        });\n\n        if (response.status !== 504) {\n          return response.json();\n        }\n      } catch (err) {\n        throw new KameleoonError(KameleoonException.ClientConfiguration);\n      }\n\n      if (i < NUMBER_OF_RETRIES) {\n        await new Promise((resolve) => setTimeout(resolve, DELAY_MILLISECONDS));\n      }\n    }\n\n    throw new KameleoonError(KameleoonException.MaximumRetriesReached);\n  }\n\n  public async getRemoteData(url: string): Promise<JSONType> {\n    const response = await fetch(url, {\n      method: HttpMethod.Get,\n    });\n\n    return response.json();\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,kBAAA,GAAAC,OAAA;AAQA,IAAAC,UAAA,GAAAD,OAAA;AAEO,MAAME,iBAAiB,CAAuC;EACnE,MAAaC,KAAKA,CAAC;IACjBC,GAAG;IACHC,OAAO;IACPC;EACmB,CAAC,EAAoB;IACxC,MAAMC,QAAQ,GAAG,MAAMC,KAAK,CAACJ,GAAG,EAAE;MAChCK,MAAM,EAAEC,6BAAU,CAACC,IAAI;MACvBN,OAAO;MACPC;IACF,CAAC,CAAC;IAEF,OAAOC,QAAQ,CAACK,EAAE;EACpB;EAEA,MAAaC,sBAAsBA,CAACT,GAAW,EAAqB;IAClE,KAAK,IAAIU,CAAC,GAAG,CAAC,EAAEA,CAAC,IAAIC,4BAAiB,EAAED,CAAC,EAAE,EAAE;MAC3C,IAAI;QACF,MAAMP,QAAQ,GAAG,MAAMC,KAAK,CAACJ,GAAG,EAAE;UAChCK,MAAM,EAAEC,6BAAU,CAACM;QACrB,CAAC,CAAC;QAEF,IAAIT,QAAQ,CAACU,MAAM,KAAK,GAAG,EAAE;UAC3B,OAAOV,QAAQ,CAACW,IAAI,EAAE;QACxB;MACF,CAAC,CAAC,OAAOC,GAAG,EAAE;QACZ,MAAM,IAAIC,iCAAc,CAACC,qCAAkB,CAACC,mBAAmB,CAAC;MAClE;MAEA,IAAIR,CAAC,GAAGC,4BAAiB,EAAE;QACzB,MAAM,IAAIQ,OAAO,CAAEC,OAAO,IAAKC,UAAU,CAACD,OAAO,EAAEE,6BAAkB,CAAC,CAAC;MACzE;IACF;IAEA,MAAM,IAAIN,iCAAc,CAACC,qCAAkB,CAACM,qBAAqB,CAAC;EACpE;EAEA,MAAaC,aAAaA,CAACxB,GAAW,EAAqB;IACzD,MAAMG,QAAQ,GAAG,MAAMC,KAAK,CAACJ,GAAG,EAAE;MAChCK,MAAM,EAAEC,6BAAU,CAACM;IACrB,CAAC,CAAC;IAEF,OAAOT,QAAQ,CAACW,IAAI,EAAE;EACxB;AACF;AAACW,OAAA,CAAA3B,iBAAA,GAAAA,iBAAA"}

package/package.json

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