@screeb/sdk-angular 0.1.1 → 0.1.2

package/dist/es/index.js

@@ -1,653 +0,0 @@
-import { Injectable, Inject, NgModule } from '@angular/core';
-import * as _Screeb from '@screeb/sdk-browser';
-
-/******************************************************************************
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-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.
-***************************************************************************** */
-/* global Reflect, Promise */
-
-
-function __decorate(decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-}
-
-function __param(paramIndex, decorator) {
-    return function (target, key) { decorator(target, key, paramIndex); }
-}
-
-function __metadata(metadataKey, metadataValue) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(metadataKey, metadataValue);
-}
-
-function __awaiter(thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-}
-
-function __generator(thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-}
-
-/**
- * Logs messages in the console with a corresponding urgency
- *
- * @param level the urgency of the message
- * @param message the message to log in the console
- */
-var log = function (level, message) {
-    var packageName = "[@screeb/angular-sdk]";
-    switch (level) {
-        case "info":
-            // eslint-disable-next-line no-console
-            console.log("".concat(packageName, " ").concat(message));
-            break;
-        case "warn":
-            // eslint-disable-next-line no-console
-            console.warn("".concat(packageName, " ").concat(message));
-            break;
-        case "error":
-            // eslint-disable-next-line no-console
-            console.error("".concat(packageName, " ").concat(message));
-            break;
-        default:
-            // eslint-disable-next-line no-console
-            console.log("".concat(packageName, " ").concat(message));
-    }
-};
-
-/** Configuration of Screeb module */
-var ScreebConfig = /** @class */ (function () {
-    function ScreebConfig() {
-    }
-    ScreebConfig = __decorate([
-        Injectable({ providedIn: "root" })
-    ], ScreebConfig);
-    return ScreebConfig;
-}());
-
-var Screeb = /** @class */ (function () {
-    // eslint-disable-next-line no-unused-vars
-    function Screeb(config) {
-        this.config = config;
-        this.isInitialized = false;
-    }
-    Screeb.prototype.ensureScreeb = function (functionName, onlyLoaded) {
-        if (onlyLoaded === void 0) { onlyLoaded = false; }
-        return __awaiter(this, void 0, void 0, function () {
-            var message, message;
-            return __generator(this, function (_a) {
-                if (!_Screeb.isLoaded() && !this.config.shouldLoad) {
-                    message = "Screeb instance is not loaded because `shouldLoad` is set to `false` in `ScreebModule` configuration.";
-                    log("warn", message);
-                    return [2 /*return*/, Promise.reject(message)];
-                }
-                if (!this.isInitialized && !onlyLoaded) {
-                    message = [
-                        "\"".concat(functionName, "\" was called but Screeb has not been initialized yet. "),
-                        "Please call 'init' before calling '".concat(functionName, "' or "),
-                        "set 'autoInit' to true in the `ScreebModule` configuration.",
-                    ].join("");
-                    log("warn", message);
-                    return [2 /*return*/, Promise.reject(message)];
-                }
-                return [2 /*return*/, Promise.resolve()];
-            });
-        });
-    };
-    /**
-     * Shutdowns current Screeb session.
-     *
-     * @example
-     * ```ts
-     * this.screeb.close();
-     * ```
-     */
-    Screeb.prototype.close = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.ensureScreeb("close")];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/, _Screeb.close()];
-                }
-            });
-        });
-    };
-    /**
-     * Prints the actual state information of Screeb tag.
-     *
-     * @example
-     * ```ts
-     * this.screeb.debug();
-     * // ******************* SCREEB SESSION DEBUG *********************
-     * // Screeb channel id: <UUID>
-     * // Screeb channel type: widget
-     * // Screeb respondent id: <UUID>
-     * // Screeb survey id: none
-     * // Screeb response id: none
-     * //
-     * // Screeb current session start: Thu May 04 2023 16:53:49 GMT+0200 (Central European Summer Time)
-     * // Screeb current session last activity: Thu May 04 2023 17:41:30 GMT+0200 (Central European Summer Time)
-     * //
-     * // Screeb targeting engine status: disabled
-     * // Screeb targeting engine: 3 surveys
-     * //
-     * // Detected platform: desktop
-     * // Detected locale: en-GB
-     * // Detected timezone: -120
-     * // **************************************************************
-     * ```
-     */
-    Screeb.prototype.debug = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.ensureScreeb("debug")];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/, _Screeb.debug()];
-                }
-            });
-        });
-    };
-    /**
-     * Tracks a user event.
-     *
-     * @param eventName The event name.
-     * @param eventProperties The properties of your event.
-     * ```text Requirements:
-     *   - Property names must be limited to 128 characters
-     *   - No more than 1000 attributes
-     *   - Supported types for values: string, number, boolean and Date.
-     * ```
-     *
-     * @example
-     * ```ts
-     * this.screeb.eventTrack(
-     *   "Product added to cart",
-     *   {
-     *     product_name: 'Red bike 2021',
-     *     category: 'sport',
-     *     color: 'red',
-     *     price: 299,
-     *     count: 1,
-     *     reference: '2CF093TG1',
-     *     delivery_method: 'UPS',
-     *     user_logged: false,
-     *     added_at: new Date(),
-     *   }
-     * );
-     * ```
-     */
-    Screeb.prototype.eventTrack = function (eventName, eventProperties) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.ensureScreeb("eventTrack")];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/, _Screeb.eventTrack(eventName, eventProperties)];
-                }
-            });
-        });
-    };
-    /**
-     * Change the current user identity.
-     * Warning: Running surveys will be closed.
-     *
-     * @param userId The unique identifier of your user.
-     * @param userProperties The properties of your user.
-     * ```text Requirements:
-     *   - Property names must be limited to 128 characters
-     *   - No more than 1000 attributes
-     *   - Supported types for values: string, number, boolean and Date.
-     * ```
-     *
-     * @example
-     * ```ts
-     * this.screeb.identity(
-     *   "<your-user-id>",
-     *   {
-     *     firstname: '<user-firstname>',
-     *     lastname: '<user-lastname>',
-     *     plan: '<user-plan>',
-     *     last_seen_at: new Date(),
-     *     authenticated: true
-     *   }
-     * );
-     * ```
-     */
-    Screeb.prototype.identity = function (userId, userProperties) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.ensureScreeb("identity")];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/, _Screeb.identity(userId, userProperties)];
-                }
-            });
-        });
-    };
-    /**
-     * Retrieves the current user identity.
-     *
-     * @example
-     * ```ts
-     * console.log(await this.screeb.identityGet());
-     * // {
-     * //   anonymous_id: "<UUID>",
-     * //   user_id: "<UUID>",
-     * //   session_id: "<UUID>",
-     * //   session_start: "2023-05-04T16:30:15.882Z",
-     * //   session_end: "2023-05-04T17:02:09.087Z",
-     * //   channel_id: "<UUID>",
-     * //   is_ready: true,
-     * // }
-     * ```
-     */
-    Screeb.prototype.identityGet = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.ensureScreeb("identityGet")];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/, _Screeb.identityGet()];
-                }
-            });
-        });
-    };
-    /**
-     * Assigns the current user to a group.
-     *
-     * @param groupName
-     * @param groupType
-     * @param groupProperties The properties of your user group.
-     * ```text Requirements:
-     *   - Property names must be limited to 128 characters
-     *   - No more than 1000 attributes
-     *   - Supported types for values: string, number, boolean and Date.
-     * ```
-     *
-     * @example
-     * ```ts
-     * this.screeb.identityGroupAssign(
-     *   'company',
-     *   'Apple',
-     *   {
-     *     address_line_1: 'Apple Campus',
-     *     address_line_2: '1 Infinite Loop',
-     *     city: 'Cupertino',
-     *     zipcode: 95014,
-     *     state: 'California',
-     *     country: 'United states',
-     *   }
-     * );
-     * ```
-     */
-    Screeb.prototype.identityGroupAssign = function (groupName, groupType, groupProperties) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.ensureScreeb("identityGroupAssign")];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/, _Screeb.identityGroupAssign(groupName, groupType, groupProperties)];
-                }
-            });
-        });
-    };
-    /**
-     * Unassigns the current user to a group.
-     *
-     * @param groupName The name of your user group.
-     * @param groupType The type of your user group.
-     *
-     * @example
-     * ```ts
-     * this.screeb.identityGroupUnassign('company', 'Apple');
-     * ```
-     */
-    Screeb.prototype.identityGroupUnassign = function (groupName, groupType) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.ensureScreeb("identityGroupUnassign")];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/, _Screeb.identityGroupUnassign(groupName, groupType)];
-                }
-            });
-        });
-    };
-    /**
-     * Adds properties to the current user identity.
-     *
-     * @param userProperties The properties of your user.
-     * ```text Requirements:
-     *   - Property names must be limited to 128 characters
-     *   - No more than 1000 attributes
-     *   - Supported types for values: string, number, boolean and Date.
-     * ```
-     *
-     * @example
-     * ```ts
-     * // Set user properties
-     * this.screeb.identityProperties(
-     *   {
-     *     firstname: '<user-firstname>',
-     *     lastname: '<user-lastname>',
-     *     plan: '<user-plan>',
-     *     last_seen_at: new Date(),
-     *     authenticated: true
-     *   }
-     * );
-     *
-     * // Delete user property : set values to null
-     * this.screeb.identityProperties(
-     *   {
-     *     age: null,
-     *     company: null,
-     *     logged: true,
-     *   }
-     * );
-     * ```
-     */
-    Screeb.prototype.identityProperties = function (userProperties) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.ensureScreeb("identityProperties")];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/, _Screeb.identityProperties(userProperties)];
-                }
-            });
-        });
-    };
-    /**
-     * Resets the current user identity.
-     * Warning: This command must be called only once, since it creates a new identity on Screeb side.
-     *
-     * @example
-     * ```ts
-     * this.screeb.identityReset();
-     * ```
-     */
-    Screeb.prototype.identityReset = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.ensureScreeb("identityReset")];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/, _Screeb.identityReset()];
-                }
-            });
-        });
-    };
-    /**
-     * Interrupts a running survey.
-     *
-     * @example
-     * ```ts
-     * this.screeb.surveyClose();
-     * ```
-     */
-    Screeb.prototype.surveyClose = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.ensureScreeb("surveyClose")];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/, _Screeb.surveyClose()];
-                }
-            });
-        });
-    };
-    /**
-     * Starts a survey by its ID.
-     *
-     * @example
-     * ```ts
-     * this.screeb.surveyStart(
-     *   '<UUID>',
-     *   false,
-     *   {
-     *     color: "green",
-     *     article_id: 42
-     *   }
-     * );
-     * ```
-     */
-    Screeb.prototype.surveyStart = function (surveyId, allowMultipleResponses, hiddenFields) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.ensureScreeb("surveyStart")];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/, _Screeb.surveyStart(surveyId, allowMultipleResponses, hiddenFields)];
-                }
-            });
-        });
-    };
-    /**
-     * Forces a targeting check.
-     *
-     * @example
-     * ```ts
-     * this.screeb.targetingCheck();
-     * ```
-     */
-    Screeb.prototype.targetingCheck = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.ensureScreeb("targetingCheck")];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/, _Screeb.targetingCheck()];
-                }
-            });
-        });
-    };
-    /**
-     * Prints the current state of the targeting engine.
-     *
-     * @example
-     * ```ts
-     * console.log(await this.screeb.targetingDebug());
-     * // targeting ************ SCREEB TARGETING RULES DEBUG **************
-     * // Disabled surveys are not listed here.
-     * //
-     * // Screeb channel id: <UUID>
-     * // Screeb respondent id: <UUID>
-     * //
-     * // Survey <UUID>:
-     * // https://admin.screeb.app/org/last/survey/<UUID>/share
-     * //
-     * //   - Rule of type "Device type (desktop/mobile/tablet)": true 🟢
-     * //   - Rule of type "Multiple display": true 🟢
-     * //   - Rule of type "Capping per time between survey display on current respondent": true 🟢
-     * //   - Rule of type "User event count": false 🔴
-     * //   - Rule of type "Capping per respondent display count": false 🔴
-     * ```
-     */
-    Screeb.prototype.targetingDebug = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.ensureScreeb("targetingDebug")];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/, _Screeb.targetingDebug()];
-                }
-            });
-        });
-    };
-    /**
-     * Initializes Screeb tag.
-     *
-     * @param websiteId Your website/channel id.
-     * @param userId The unique identifier of your user.
-     * @param userProperties The properties of your user.
-     * ```text Requirements:
-     *   - Property names must be limited to 128 characters
-     *   - No more than 1000 attributes
-     *   - Supported types for values: string, number, boolean and Date
-     * ```
-     *
-     * @example
-     * ```ts
-     * this.screeb.init(
-     *   "<your-website-id>",
-     *   "<your-user-id>",
-     *   {
-     *     firstname: '<user-firstname>',
-     *     lastname: '<user-lastname>',
-     *     plan: '<user-plan>',
-     *     last_seen_at: new Date(),
-     *     authenticated: true
-     *   }
-     * );
-     * ```
-     */
-    Screeb.prototype.init = function (websiteId, userId, userProperties) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.ensureScreeb("init", true)];
-                    case 1:
-                        _a.sent();
-                        this.isInitialized = true;
-                        return [4 /*yield*/, _Screeb.init(websiteId, userId, userProperties)];
-                    case 2: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
-    /**
-     * Appends Screeb tag into your dom.
-     *
-     * @param options Screeb module options.
-     * @param options.window If you're running Screeb tag in an iframe, please set the inner window here.
-     * @param options.screebEndpoint Please don't do this.
-     *
-     * @example
-     * ```ts
-     * this.screeb.load();
-     * ```
-     */
-    Screeb.prototype.load = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                return [2 /*return*/, _Screeb.load()];
-            });
-        });
-    };
-    Screeb = __decorate([
-        Injectable({ providedIn: "root" }),
-        __param(0, Inject(ScreebConfig)),
-        __metadata("design:paramtypes", [ScreebConfig])
-    ], Screeb);
-    return Screeb;
-}());
-
-var ScreebModule = /** @class */ (function () {
-    function ScreebModule(config, screeb) {
-        var _a, _b;
-        if ((_a = config.shouldLoad) !== null && _a !== void 0 ? _a : true) {
-            screeb.load();
-        }
-        if (((_b = config.autoInit) !== null && _b !== void 0 ? _b : false) && config.websiteId) {
-            screeb.init(config.websiteId, config.userId, config.userProperties);
-        }
-    }
-    ScreebModule_1 = ScreebModule;
-    /**
-     * This is used to initialize Screeb at the top of your Angular application
-     * @param config Configuration to pass to Screeb browser SDK
-     *
-     * @example
-     * ```ts
-     * ScreebModule.forRoot({
-     *   autoInit: true,
-     *   "<your-website-id>",
-     *   "<your-user-id>",
-     *   {
-     *     firstname: '<user-firstname>',
-     *     lastname: '<user-lastname>',
-     *     plan: '<user-plan>',
-     *     last_seen_at: new Date(),
-     *     authenticated: true
-     *   }
-     * })
-     * ```
-     */
-    ScreebModule.forRoot = function (config) {
-        return {
-            ngModule: ScreebModule_1,
-            providers: [Screeb, { provide: ScreebConfig, useValue: config }],
-        };
-    };
-    var ScreebModule_1;
-    ScreebModule = ScreebModule_1 = __decorate([
-        NgModule({
-            providers: [Screeb, ScreebConfig],
-        }),
-        __param(0, Inject(ScreebConfig)),
-        __param(1, Inject(Screeb)),
-        __metadata("design:paramtypes", [ScreebConfig,
-            Screeb])
-    ], ScreebModule);
-    return ScreebModule;
-}());
-
-export { Screeb, ScreebConfig, ScreebModule };