@kameleoon/javascript-sdk 0.0.2 → 1.1.0

package/LICENSE.md

@@ -0,0 +1,6 @@
+Copyright 2023 Kameleoon
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+

package/README.md

@@ -1,8 +1,54 @@
 # Kameleoon JavaScript SDK
 
-Our SDK gives you the possibility of running experiments and activating feature flags on your front-end JavaScript application. Integrating our SDK into your web-application is easy, and its footprint (in terms of memory and network usage) is low.
+## Introduction
+Kameleoon JavaScript SDK is used to work with Kameleoon Feature Flags and Experiments using native JavaScript api. 
+Integration of this SDK into web application is easy, and its footprint is low.
 
-## Learn more
+This page describes the most basic `KameleoonClient` configuration, for more in-depth review of all the methods and configuration options follow [Official Kameleoon Documentation](https://developers.kameleoon.com/javascript-sdk.html)
+
+## Contents
+- [Installation](#installation)
+- [Configuration](#configuration)
+
+## Installation
+- **npm** - `npm install @kameleoon/javascript-sdk`
+- **yarn** - `yarn add @kameleoon/javascript-sdk`
+- **pnpm** - `pnpm add @kameleoon/javascript-sdk`
+
+## Configuration
+
+1. Obtain your site code from [Kameleoon Platform](https://app.kameleoon.com/)
+2. Create client instance
+```ts
+import { KameleoonClient } from '@kameleoon/javascript-sdk';
+
+const client = new KameleoonClient('my_site_code');
+```
+3. Asynchronously initialize client to fetch the configuration from remote server and handle possible errors
+```ts
+try {
+  await client.initialize();
+} catch (error) {
+  // Handle error
+}
+```
+4. `KameleoonClient` is ready to go!
+```ts
+const visitorCode = KameleoonUtils.getVisitorCode('www.example.com');
+const experimentId = 100;
+const customDataIndex = 0;
+
+// -- Get variation id
+const variationId = client.triggerExperiment('my_visitor_code', experimentId);
+
+// -- Add targeting data
+client.addData(visitorCode, new CustomData(customDataIndex, 'my_data'));
+
+// -- Check if the feature is active for visitor
+const isMyFeatureActive = client.isFeatureFlagActive(
+  visitorCode,
+  'my_feature_key',
+);
+```
 
-You can refer to the [SDK reference](https://developers.kameleoon.com/javascript-sdk.html#reference) to check out all possible features of the SDK. Also make sure you check out our [Getting started tutorial](https://developers.kameleoon.com/javascript-sdk.html#getting-started) which we have prepared to walk you through the installation and implementation.
 

package/dist/eventSource.d.ts

@@ -0,0 +1,4 @@
+import { IExternalEventSource, IExternalEventSourceConstructor } from '@kameleoon/javascript-sdk-core';
+export declare class EventSourceConstructor implements IExternalEventSourceConstructor {
+    initialize(url: string): IExternalEventSource;
+}

package/dist/eventSource.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventSourceConstructor = void 0;
+class EventSourceConstructor {
+    initialize(url) {
+        return new ExternalEventSource(url);
+    }
+}
+exports.EventSourceConstructor = EventSourceConstructor;
+// --- Note ---
+// - `EventSource` has no dedicated tests because same browser instance
+// is tested thoroughly inside core and would just duplicate tests
+// - Moreover we would have to import some unexposed details like constructed url
+// or the `eventType` from the core
+class ExternalEventSource {
+    constructor(url) {
+        const eventSource = new EventSource(url);
+        this.eventSource = eventSource;
+    }
+    open({ siteCode, eventType, onEvent, }) {
+        this.eventSource.addEventListener(eventType, (message) => {
+            const event = JSON.parse(message.data);
+            const { siteCode: eventSiteCode, ts } = event;
+            if (siteCode === eventSiteCode) {
+                onEvent(ts);
+            }
+        });
+    }
+    close() {
+        this.eventSource.close();
+    }
+}
+//# sourceMappingURL=eventSource.js.map

package/dist/eventSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventSource.js","sourceRoot":"","sources":["../src/eventSource.ts"],"names":[],"mappings":";;;AAOA,MAAa,sBAAsB;IAC1B,UAAU,CAAC,GAAW;QAC3B,OAAO,IAAI,mBAAmB,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;CACF;AAJD,wDAIC;AAED,eAAe;AACf,uEAAuE;AACvE,kEAAkE;AAClE,iFAAiF;AACjF,mCAAmC;AACnC,MAAM,mBAAmB;IAGvB,YAAY,GAAW;QACrB,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC;QAEzC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAEM,IAAI,CAAC,EACV,QAAQ,EACR,SAAS,EACT,OAAO,GACuB;QAC9B,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE;YACvD,MAAM,KAAK,GAAsB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC1D,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,EAAE,EAAE,GAAG,KAAK,CAAC;YAE9C,IAAI,QAAQ,KAAK,aAAa,EAAE;gBAC9B,OAAO,CAAC,EAAE,CAAC,CAAC;aACb;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;IAC3B,CAAC;CACF"}

package/dist/index.d.ts

@@ -1 +1,3 @@
+export * from '@kameleoon/javascript-sdk-core';
 export { KameleoonClient } from './kameleoonClient';
+export { KameleoonUtils } from './kameleoonUtils';

package/dist/index.js

@@ -1,6 +1,23 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KameleoonClient = void 0;
+exports.KameleoonUtils = exports.KameleoonClient = void 0;
+__exportStar(require("@kameleoon/javascript-sdk-core"), exports);
 var kameleoonClient_1 = require("./kameleoonClient");
 Object.defineProperty(exports, "KameleoonClient", { enumerable: true, get: function () { return kameleoonClient_1.KameleoonClient; } });
+var kameleoonUtils_1 = require("./kameleoonUtils");
+Object.defineProperty(exports, "KameleoonUtils", { enumerable: true, get: function () { return kameleoonUtils_1.KameleoonUtils; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qDAAoD;AAA3C,kHAAA,eAAe,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,iEAA+C;AAC/C,qDAAoD;AAA3C,kHAAA,eAAe,OAAA;AACxB,mDAAkD;AAAzC,gHAAA,cAAc,OAAA"}

package/dist/kameleoonClient.d.ts

@@ -1,103 +1,8 @@
-import Configuration from './configurations/configuration';
-import Data from './data';
-import TargetingData from './targeting/targetingData';
-import Experiment from './configurations/experiment';
-import FeatureFlag from './configurations/featureFlag';
-import ExperimentConfigurationNotFound from './exceptions/experimentConfigurationNotFound';
-import FeatureConfigurationNotFound from './exceptions/featureConfigurationNotFound';
-import NotActivated from './exceptions/notActivated';
-import NotTargeted from './exceptions/notTargeted';
-import VariationConfigurationNotFound from './exceptions/variationConfigurationNotFound';
-import CredentialsNotFound from './exceptions/credentialsNotFound';
-import { CallbackInterface, DataInterface, SDKConfiguration } from './interfaces/interfaces';
-declare class KameleoonClient {
-    static readonly VISITOR_CODE_MAX_LENGTH = 255;
-    configurations?: Configuration;
-    ready: boolean;
-    readyCallbacks: CallbackInterface[];
-    minutesBetweenConfigurationUpdate: number;
-    siteCode: string;
-    targetingData: {
-        [visitorCode: string]: TargetingData[];
-    };
-    targetingDataNumberEntriesAuthorized: number;
-    unsentData: {
-        [visitorCode: string]: DataInterface[];
-    };
-    visitorDataMaximumSize: number;
-    environment: string | null;
-    private realTimeConfigurationService;
-    private handlerUpdateConfiguration;
-    private variationStorage;
-    constructor(siteCode: string, configuration?: SDKConfiguration);
-    private updateCampaignConfiguration;
-    runWhenReady: (successCallback: () => void, errorCallback: () => void, timeout: number) => void;
-    clearCallbacks: (success: boolean, errorCallback?: (() => void) | undefined) => void;
-    trackConversion: (visitorCode: string, goalId: number, revenue?: number | undefined) => void;
-    flush: (visitorCode?: string | undefined) => void;
-    triggerExperiment: (visitorCode: string, experimentId: number) => number;
-    activateFeature: (visitorCode: string, featureIdOrName: number | string) => boolean;
-    generateRandomString: () => string;
-    obtainVisitorCode: (domain: string, defaultVisitorCode?: string | undefined) => string;
-    obtainHashDouble: (containerId: number, visitorCode: string, xpConf: Experiment | FeatureFlag) => number;
-    private getCommonSSXParameters;
-    private getDataTrackingURL;
-    private getAPIDataRequestURL;
-    private getEventsRequestURL;
-    getExperimentRegisterURL: (visitorCode: string, experimentId: number, variationId?: number | undefined, noneVariation?: boolean | undefined) => string;
-    getUnsentUsers: () => string[];
-    getUnsentData: (visitorCode: string) => DataInterface[];
-    getTargetingData: (visitorCode: string) => TargetingData[];
-    emptyUnsentData: (visitorCode: string) => void;
-    emptyTargetingData: () => void;
-    addData: (visitorCode: string, ...data: DataInterface[]) => void;
-    checkTargeting: (visitorCode: string, campaignId: number, isFF: boolean) => boolean | null;
-    private getConditionData;
-    obtainVariationAssociatedData: (variationId: number) => Record<string | number | symbol, string | number | boolean | {
-        [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any)[])[])[])[])[])[])[])[])[])[])[];
-    } | (string | number | boolean | {
-        [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any)[])[])[])[])[])[])[])[])[])[])[];
-    } | (string | number | boolean | {
-        [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any)[])[])[])[])[])[])[])[])[])[])[];
-    } | (string | number | boolean | {
-        [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any)[])[])[])[])[])[])[])[])[])[])[];
-    } | (string | number | boolean | {
-        [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any)[])[])[])[])[])[])[])[])[])[])[];
-    } | (string | number | boolean | {
-        [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any)[])[])[])[])[])[])[])[])[])[])[];
-    } | (string | number | boolean | {
-        [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any)[])[])[])[])[])[])[])[])[])[])[];
-    } | (string | number | boolean | {
-        [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any)[])[])[])[])[])[])[])[])[])[])[];
-    } | (string | number | boolean | {
-        [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any)[])[])[])[])[])[])[])[])[])[])[];
-    } | (string | number | boolean | {
-        [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any)[])[])[])[])[])[])[])[])[])[])[];
-    } | (string | number | boolean | {
-        [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any)[])[])[])[])[])[])[])[])[])[])[];
-    } | (string | number | boolean | {
-        [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any)[])[])[])[])[])[])[])[])[])[])[];
-    } | any)[])[])[])[])[])[])[])[])[])[])[]>;
-    obtainFeatureVariable: (featureIdOrName: number | string, variable: string) => any;
-    retrieveDataFromRemoteSource: (key: string) => Promise<any>;
-    private _parseJsonValue;
-    private saveConfiguration;
-    private validateVisitorCode;
-    private checkSiteEnabled;
-    private checkFeatureKeyOrId;
-    private getAndClearUnsentData;
-    onUpdateConfiguration: (handler: () => void) => void;
-    private manageConfiguraitonUpdate;
-    private fireUpdateConfigurationHandler;
+import { KameleoonCore, SDKConfigurationType } 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>);
 }
-declare const KameleoonException: {
-    ExperimentConfigurationNotFound: typeof ExperimentConfigurationNotFound;
-    FeatureConfigurationNotFound: typeof FeatureConfigurationNotFound;
-    VariationConfigurationNotFound: typeof VariationConfigurationNotFound;
-    NotTargeted: typeof NotTargeted;
-    NotActivated: typeof NotActivated;
-    CredentialsNotFound: typeof CredentialsNotFound;
-};
-export { KameleoonClient };
-export { Data as KameleoonData };
-export { KameleoonException };