@screeb/sdk-browser 0.1.2

package/dist/es/index.js

@@ -0,0 +1,410 @@
+var SCREEB_TAG_ENDPOINT = "https://t.screeb.app/tag.js";
+var _window = window;
+/**
+ * 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
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.load();
+ * ```
+ */
+var load = function (options) {
+    if (options === void 0) { options = {}; }
+    return new Promise(function (resolve, reject) {
+        var _a, _b, _c;
+        _window = (_a = options.window) !== null && _a !== void 0 ? _a : window;
+        var scriptElement = document.createElement("script");
+        scriptElement.async = true;
+        scriptElement.src = (_b = options.screebEndpoint) !== null && _b !== void 0 ? _b : SCREEB_TAG_ENDPOINT;
+        scriptElement.addEventListener("load", function () { return resolve(undefined); });
+        scriptElement.addEventListener("error", reject);
+        _window.$screeb =
+            (_c = _window.$screeb) !== null && _c !== void 0 ? _c : function () {
+                var _a;
+                var args = [];
+                for (var _i = 0; _i < arguments.length; _i++) {
+                    args[_i] = arguments[_i];
+                }
+                if (_window.$screeb) {
+                    (_window.$screeb.q = (_a = _window.$screeb.q) !== null && _a !== void 0 ? _a : []).push(args);
+                }
+            };
+        _window.document.head.appendChild(scriptElement);
+    });
+};
+/**
+ * Initializes Screeb tag.
+ *
+ * @param websiteId Your website/channel id.
+ * @param visitorId The unique identifier of your visitor.
+ * @param visitorProperties The properties of your visitor.
+ * ```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
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.init(
+ *   "<your-website-id>",
+ *   "<your-visitor-id>",
+ *   {
+ *     firstname: '<user-firstname>',
+ *     lastname: '<user-lastname>',
+ *     plan: '<user-plan>',
+ *     last_seen_at: new Date(),
+ *     authenticated: true
+ *   }
+ * );
+ * ```
+ */
+var init = function (websiteId, visitorId, visitorProperties) {
+    var identityObject;
+    if (visitorId || visitorProperties) {
+        identityObject = {
+            identity: {
+                id: visitorId,
+                properties: visitorProperties,
+            },
+        };
+    }
+    return $screeb("init", websiteId, identityObject);
+};
+/**
+ * Checks if Screeb tag has been loaded.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * console.log(Screeb.isLoaded()); // false
+ * Screeb.load();
+ * console.log(Screeb.isLoaded()); // true
+ * ```
+ */
+var isLoaded = function () { return $screeb && typeof $screeb === "function"; };
+/**
+ * Shutdowns current Screeb session.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.close();
+ * ```
+ */
+var close = function () { return $screeb("close"); };
+/**
+ * Prints the actual state information of Screeb tag.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * 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
+ * // **************************************************************
+ * ```
+ */
+var debug = function () { return $screeb("debug"); };
+/**
+ * Tracks a visitor 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
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.init(
+ *   "event.track",
+ *   "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(),
+ *   }
+ * );
+ * ```
+ */
+var eventTrack = function (eventName, eventProperties) { return $screeb("event.track", eventName, eventProperties); };
+/**
+ * Change the current visitor identity.
+ * Warning: Running surveys will be closed.
+ *
+ * @param visitorId The unique identifier of your visitor.
+ * @param visitorProperties The properties of your visitor.
+ * ```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
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.identity(
+ *   "<your-visitor-id>",
+ *   {
+ *     firstname: '<user-firstname>',
+ *     lastname: '<user-lastname>',
+ *     plan: '<user-plan>',
+ *     last_seen_at: new Date(),
+ *     authenticated: true
+ *   }
+ * );
+ * ```
+ */
+var identity = function (visitorId, visitorProperties) { return $screeb("identity", visitorId, visitorProperties); };
+/**
+ * Retrieves the current visitor identity.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * console.log(await 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,
+ * // }
+ * ```
+ */
+var identityGet = function () {
+    return $screeb("identity.get");
+};
+/**
+ * Assigns the current visitor to a group.
+ *
+ * @param groupName
+ * @param groupType
+ * @param groupProperties The properties of your visitor 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
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.identityGroupAssign(
+ *   'company',
+ *   'Apple',
+ *   {
+ *     address_line_1: 'Apple Campus',
+ *     address_line_2: '1 Infinite Loop',
+ *     city: 'Cupertino',
+ *     zipcode: 95014,
+ *     state: 'California',
+ *     country: 'United states',
+ *   }
+ * );
+ * ```
+ */
+var identityGroupAssign = function (groupName, groupType, groupProperties) { return $screeb("identity.group.assign", groupType, groupName, groupProperties); };
+/**
+ * Unassigns the current visitor to a group.
+ *
+ * @param groupName The name of your visitor group.
+ * @param groupType The type of your visitor group.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.identityGroupUnassign('company', 'Apple');
+ * ```
+ */
+var identityGroupUnassign = function (groupName, groupType) {
+    return $screeb("identity.group.unassign", groupType, groupName);
+};
+/**
+ * Adds properties to the current visitor identity.
+ *
+ * @param visitorProperties The properties of your visitor.
+ * ```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
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * // Set visitor properties
+ * Screeb.identityProperties(
+ *   {
+ *     firstname: '<user-firstname>',
+ *     lastname: '<user-lastname>',
+ *     plan: '<user-plan>',
+ *     last_seen_at: new Date(),
+ *     authenticated: true
+ *   }
+ * );
+ *
+ * // Delete visitor property : set values to null
+ * Screeb.identityProperties(
+ *   {
+ *     age: null,
+ *     company: null,
+ *     logged: true,
+ *   }
+ * );
+ * ```
+ */
+var identityProperties = function (visitorProperties) {
+    return $screeb("identity.properties", visitorProperties);
+};
+/**
+ * Resets the current visitor identity.
+ * Warning: This command must be called only once, since it creates a new identity on Screeb side.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.identityReset();
+ * ```
+ */
+var identityReset = function () { return $screeb("identity.reset"); };
+/**
+ * Interrupts a running survey.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.surveyClose();
+ * ```
+ */
+var surveyClose = function () { return $screeb("survey.close"); };
+/**
+ * Starts a survey by its ID.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.surveyStart(
+ *   '<UUID>',
+ *   false,
+ *   {
+ *     color: "green",
+ *     article_id: 42
+ *   }
+ * );
+ * ```
+ */
+var surveyStart = function (surveyId, allowMultipleResponses, hiddenFields) {
+    if (allowMultipleResponses === void 0) { allowMultipleResponses = false; }
+    if (hiddenFields === void 0) { hiddenFields = {}; }
+    return $screeb("survey.start", surveyId, {
+        allow_multiple_responses: allowMultipleResponses,
+        hidden_fields: hiddenFields,
+    });
+};
+/**
+ * Forces a targeting check.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.targetingCheck();
+ * ```
+ */
+var targetingCheck = function () { return $screeb("targeting.check"); };
+/**
+ * Prints the current state of the targeting engine.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * 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 🔴
+ * ```
+ */
+var targetingDebug = function () { return $screeb("targeting.debug"); };
+/**
+ * Starts the targeting engine.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.targetingStart();
+ * ```
+ */
+var targetingStart = function () { return $screeb("targeting.start"); };
+/**
+ * Stops the targeting engine.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.targetingStop();
+ * ```
+ */
+var targetingStop = function () { return $screeb("targeting.stop"); };
+
+export { close, debug, eventTrack, identity, identityGet, identityGroupAssign, identityGroupUnassign, identityProperties, identityReset, init, isLoaded, load, surveyClose, surveyStart, targetingCheck, targetingDebug, targetingStart, targetingStop };

package/docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.