@croct/plug 0.8.3 → 0.10.1

package/README.md

@@ -138,6 +138,7 @@ The following references provide guidance to help you get started, integrate, an
 - [Patch Reference](docs/patch.md)
 - [User Reference](docs/user.md)
 - [Session Reference](docs/session.md)
+- [Testing](docs/testing.md)
 - [Troubleshooting](docs/troubleshooting.md)
 
 If you are new to the Croct platform, the [quick start guide](docs/quick-start.md) is a good starting point for 

package/fetch.d.ts

@@ -1,6 +1,10 @@
-import { NullableJsonObject } from './sdk/json';
+import { NullableJsonObject, JsonObject } from './sdk/json';
 export interface SlotMap {
 }
+export declare type FetchOptions = {
+    timeout?: number;
+    attributes?: JsonObject;
+};
 export declare type SlotId = keyof SlotMap extends never ? string : keyof SlotMap;
 export declare type SlotContent<I extends SlotId> = I extends keyof SlotMap ? SlotMap[I] : NullableJsonObject;
 export declare type FetchResponse<I extends SlotId, P extends NullableJsonObject = NullableJsonObject> = {

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@croct/plug",
-  "version": "0.8.3",
+  "version": "0.10.1",
   "description": "A fully-featured devkit for building natively personalized applications.",
   "license": "MIT",
   "author": {
     "name": "Croct",
-    "email": "plug-js+lib@croct.com",
+    "email": "lib+plug-js@croct.com",
     "url": "https://croct.com"
   },
   "keywords": [
@@ -33,7 +33,8 @@
     "bundle": "rollup -c"
   },
   "dependencies": {
-    "@croct/sdk": "^0.6.1",
+    "@croct/json": "^1.1.0",
+    "@croct/sdk": "^0.9.1",
     "tslib": "^2.2.0"
   },
   "devDependencies": {

package/plug.d.ts

@@ -7,7 +7,7 @@ import { Optional } from '@croct/sdk/utilityTypes';
 import { ExternalTrackingEvent as ExternalEvent, ExternalTrackingEventPayload as ExternalEventPayload, ExternalTrackingEventType as ExternalEventType } from '@croct/sdk/trackingEvents';
 import { PluginFactory } from './plugin';
 import { EapFeatures } from './eap';
-import { SlotId, FetchResponse } from './fetch';
+import { SlotId, FetchResponse, FetchOptions } from './fetch';
 import { NullableJsonObject, JsonValue } from './sdk/json';
 export interface PluginConfigurations {
     [key: string]: any;
@@ -62,7 +62,7 @@ export declare class GlobalPlug implements Plug {
     /**
      * This API is unstable and subject to change in future releases.
      */
-    fetch<P extends NullableJsonObject, I extends SlotId = SlotId>(slotId: I): Promise<FetchResponse<I, P>>;
+    fetch<P extends NullableJsonObject, I extends SlotId = SlotId>(slotId: I, options?: FetchOptions): Promise<FetchResponse<I, P>>;
     unplug(): Promise<void>;
     private eap;
 }

package/plug.js

@@ -35,7 +35,7 @@ var GlobalPlug = /** @class */ (function () {
     GlobalPlug.prototype.plug = function (configuration) {
         var e_1, _a;
         var _this = this;
-        var _b, _c;
+        var _b, _c, _d, _e;
         if (configuration === void 0) { configuration = {}; }
         if (this.instance !== undefined) {
             var logger_1 = this.instance.getLogger();
@@ -54,8 +54,10 @@ var GlobalPlug = /** @class */ (function () {
             throw new Error('The app ID must be specified when it cannot be auto-detected. '
                 + 'Please try again specifying the "appId" option.');
         }
-        var plugins = configuration.plugins, sdkConfiguration = tslib_1.__rest(configuration, ["plugins"]);
-        var sdk = sdkFacade_1.SdkFacade.init(tslib_1.__assign(tslib_1.__assign({}, sdkConfiguration), { appId: appId }));
+        var plugins = configuration.plugins, test = configuration.test, sdkConfiguration = tslib_1.__rest(configuration, ["plugins", "test"]);
+        var sdk = sdkFacade_1.SdkFacade.init(tslib_1.__assign(tslib_1.__assign({}, sdkConfiguration), { appId: appId, test: test !== null && test !== void 0 ? test : (typeof process === 'object' && (((_c = process.env) === null || _c === void 0 ? void 0 : _c.CROCT_TEST_MODE) !== undefined
+                ? process.env.CROCT_TEST_MODE === 'true'
+                : ((_d = process.env) === null || _d === void 0 ? void 0 : _d.NODE_ENV) === 'test')) }));
         this.instance = sdk;
         var logger = this.instance.getLogger();
         if (detectedAppId === configuredAppId) {
@@ -142,19 +144,19 @@ var GlobalPlug = /** @class */ (function () {
         };
         var this_1 = this;
         try {
-            for (var _d = tslib_1.__values(Object.entries(tslib_1.__assign({ playground: true }, plugins))), _e = _d.next(); !_e.done; _e = _d.next()) {
-                var _f = tslib_1.__read(_e.value, 2), name_1 = _f[0], options = _f[1];
+            for (var _f = tslib_1.__values(Object.entries(tslib_1.__assign({ playground: true }, plugins))), _g = _f.next(); !_g.done; _g = _f.next()) {
+                var _h = tslib_1.__read(_g.value, 2), name_1 = _h[0], options = _h[1];
                 _loop_1(name_1, options);
             }
         }
         catch (e_1_1) { e_1 = { error: e_1_1 }; }
         finally {
             try {
-                if (_e && !_e.done && (_a = _d.return)) _a.call(_d);
+                if (_g && !_g.done && (_a = _f.return)) _a.call(_f);
             }
             finally { if (e_1) throw e_1.error; }
         }
-        var initializeEap = (_c = window.croctEap) === null || _c === void 0 ? void 0 : _c.initialize;
+        var initializeEap = (_e = window.croctEap) === null || _e === void 0 ? void 0 : _e.initialize;
         if (typeof initializeEap === 'function') {
             initializeEap.call(this);
         }
@@ -260,8 +262,9 @@ var GlobalPlug = /** @class */ (function () {
     /**
      * This API is unstable and subject to change in future releases.
      */
-    GlobalPlug.prototype.fetch = function (slotId) {
-        return this.eap('fetch').call(this, slotId);
+    GlobalPlug.prototype.fetch = function (slotId, options) {
+        if (options === void 0) { options = {}; }
+        return this.eap('fetch').call(this, slotId, options);
     };
     GlobalPlug.prototype.unplug = function () {
         return tslib_1.__awaiter(this, void 0, void 0, function () {

package/sdk/json.d.ts

@@ -1,3 +1,3 @@
-import { JsonObject } from '@croct/sdk/json';
-export * from '@croct/sdk/json';
+import { JsonObject } from '@croct/json';
+export * from '@croct/json/mutable';
 export declare type NullableJsonObject = JsonObject | null;

package/sdk/json.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var tslib_1 = require("tslib");
-tslib_1.__exportStar(require("@croct/sdk/json"), exports);
+tslib_1.__exportStar(require("@croct/json/mutable"), exports);

package/sdk/tracking.d.ts

@@ -1,3 +1,6 @@
+import { EventInfo as SdkEventInfo } from '@croct/sdk/tracker';
+import { TrackingEvent, TrackingEventType } from '@croct/sdk/trackingEvents';
 export { TrackerFacade } from '@croct/sdk/facade/trackerFacade';
-export { EventInfo, EventListener } from '@croct/sdk/tracker';
+export { EventListener } from '@croct/sdk/tracker';
 export { TrackingEvent, TrackingEventType, ExternalTrackingEvent, ExternalTrackingEventPayload, ExternalTrackingEventType, } from '@croct/sdk/trackingEvents';
+export declare type EventInfo<T extends TrackingEventType> = SdkEventInfo<TrackingEvent<T>>;