@screeb/sdk-browser 0.1.11 → 0.1.13

package/dist/cjs/hooks.types.d.ts

@@ -0,0 +1,81 @@
+export type ChannelType = "widget" | "ios" | "android";
+export type Channel = {
+    id: string;
+    type: ChannelType;
+};
+export type User = {
+    anonymous_id: string;
+    userId?: string;
+};
+export type SurveyFormat = "conversationnal" | "cards";
+export type SurveySize = 25 | 50 | 75 | 100 | 125 | 150;
+export type SurveyPosition = "center-left" | "center-center" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right";
+export type Survey = {
+    id: string;
+    survey_position: SurveyPosition;
+    survey_format: SurveyFormat;
+    survey_size: 100;
+};
+export type ResponseStatus = "displayed" | "started" | "ended" | "closed" | "interrupted";
+export type ResponseItemQuestion = {
+    id: string;
+    title: string;
+    type: "text" | "video";
+    url?: string;
+};
+export type ResponseItemAnswer = {
+    replied_at?: string;
+    fields?: {
+        type: "string" | "number" | "boolean" | "none" | "time" | "file";
+        text?: string;
+        number?: number;
+        boolean?: boolean;
+        time?: string;
+    }[];
+};
+export type ResponseItem = {
+    question: ResponseItemQuestion;
+    answer: ResponseItemAnswer;
+};
+export type HookCommonProperties = {
+    channel: Channel;
+    user: User;
+    survey: Survey;
+};
+export type HookOnReady = (data: {
+    channel: Channel;
+    user: User;
+}) => void;
+export type HookOnSurveyShowed = (data: HookCommonProperties & {
+    response: {
+        id: string;
+        items: ResponseItem[];
+    };
+}) => void;
+export type HookOnSurveyStarted = (data: HookCommonProperties & {
+    response: {
+        id: string;
+    };
+}) => void;
+export type HookOnQuestionReplied = (data: HookCommonProperties & {
+    response: {
+        id: string;
+        status: null;
+        question: ResponseItemQuestion;
+        answer: ResponseItemAnswer;
+        items: ResponseItem[];
+    };
+}) => void;
+export type HookOnSurveyCompleted = (data: HookCommonProperties & {
+    response: {
+        id: string;
+        items: ResponseItem[];
+    };
+}) => void;
+export type HookOnSurveyHidden = (data: HookCommonProperties & {
+    response: {
+        id: string;
+        items: ResponseItem[];
+        hide_reason: ResponseStatus;
+    };
+}) => void;

package/dist/cjs/index.d.ts

@@ -0,0 +1,349 @@
+import { Hooks, PropertyRecord, ScreebIdentityGetReturn, ScreebOptions } from "./types";
+export * from "./types";
+export * from "./hooks.types";
+/**
+ * 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();
+ * ```
+ */
+export declare const load: (options?: ScreebOptions) => Promise<undefined>;
+/**
+ * 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
+ * ```
+ * @param hooks Hooks to be called when SDK is ready or a survey is showed, started, completed, hidden
+ * or when a question is replied.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.init(
+ *   "<your-website-id>",
+ *   "<your-user-id>",
+ *   {
+ *     firstname: '<user-firstname>',
+ *     lastname: '<user-lastname>',
+ *     plan: '<user-plan>',
+ *     last_seen_at: new Date(),
+ *     authenticated: true
+ *   },
+ *   {
+ *     version: "1.0.0",
+ *     onReady: (payload) =>  console.log("Screeb SDK is ready!", payload),
+ *   },
+ * );
+ * ```
+ */
+export declare const init: (websiteId: string, userId?: string, userProperties?: PropertyRecord, hooks?: Hooks) => void | Promise<unknown>;
+/**
+ * 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
+ * ```
+ */
+export declare const isLoaded: () => boolean | undefined;
+/**
+ * Shutdowns current Screeb session.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.close();
+ * ```
+ */
+export declare const close: () => void | Promise<unknown>;
+/**
+ * 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
+ * // **************************************************************
+ * ```
+ */
+export declare const debug: () => void | Promise<unknown>;
+/**
+ * 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
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * 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(),
+ *   }
+ * );
+ * ```
+ */
+export declare const eventTrack: (eventName: string, eventProperties?: PropertyRecord) => void | Promise<unknown>;
+/**
+ * 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
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.identity(
+ *   "<your-user-id>",
+ *   {
+ *     firstname: '<user-firstname>',
+ *     lastname: '<user-lastname>',
+ *     plan: '<user-plan>',
+ *     last_seen_at: new Date(),
+ *     authenticated: true
+ *   }
+ * );
+ * ```
+ */
+export declare const identity: (userId: string, userProperties?: PropertyRecord) => void | Promise<unknown>;
+/**
+ * Retrieves the current user 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,
+ * // }
+ * ```
+ */
+export declare const identityGet: () => Promise<ScreebIdentityGetReturn>;
+/**
+ * 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
+ * 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',
+ *   }
+ * );
+ * ```
+ */
+export declare const identityGroupAssign: (groupName: string, groupType?: string, groupProperties?: PropertyRecord) => void | Promise<unknown>;
+/**
+ * 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
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.identityGroupUnassign('company', 'Apple');
+ * ```
+ */
+export declare const identityGroupUnassign: (groupName: string, groupType?: string) => void | Promise<unknown>;
+/**
+ * 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
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * // Set user properties
+ * 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
+ * Screeb.identityProperties(
+ *   {
+ *     age: null,
+ *     company: null,
+ *     logged: true,
+ *   }
+ * );
+ * ```
+ */
+export declare const identityProperties: (userProperties: PropertyRecord) => void | Promise<unknown>;
+/**
+ * Resets the current user 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();
+ * ```
+ */
+export declare const identityReset: () => void | Promise<unknown>;
+/**
+ * Interrupts a running survey.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.surveyClose();
+ * ```
+ */
+export declare const surveyClose: () => void | Promise<unknown>;
+/**
+ * Starts a survey by its ID.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.surveyStart(
+ *   '<UUID>',
+ *   false,
+ *   {
+ *     color: "green",
+ *     article_id: 42
+ *   },
+ *   {
+ *     version: "1.0.0",
+ *     onSurveyShowed: (payload) => console.log("Survey showed", payload),
+ *   },
+ * );
+ * ```
+ */
+export declare const surveyStart: (surveyId: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: Hooks) => void | Promise<unknown>;
+/**
+ * Forces a targeting check.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.targetingCheck();
+ * ```
+ */
+export declare const targetingCheck: () => void | Promise<unknown>;
+/**
+ * Prints the current state of the targeting engine.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * console.log(await 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 🔴
+ * ```
+ */
+export declare const targetingDebug: () => void | Promise<unknown>;

package/dist/cjs/index.js

@@ -0,0 +1,440 @@
+'use strict';
+
+var SCREEB_TAG_ENDPOINT = "https://t.screeb.app/tag.js";
+var _window = typeof window === "undefined" ? undefined : window;
+var callScreebCommand = function () {
+    var args = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        args[_i] = arguments[_i];
+    }
+    if (_window === null || _window === void 0 ? void 0 : _window.$screeb) {
+        return _window.$screeb.apply(_window.$screeb, args);
+    }
+    return Promise.reject("[Screeb] Screeb.load() must be called before any other function.");
+};
+/**
+ * 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 args = [];
+                for (var _i = 0; _i < arguments.length; _i++) {
+                    args[_i] = arguments[_i];
+                }
+                return new Promise(function (a, b) {
+                    var _a;
+                    if (_window === null || _window === void 0 ? void 0 : _window.$screeb) {
+                        return (_window.$screeb.q = (_a = _window.$screeb.q) !== null && _a !== void 0 ? _a : []).push({
+                            args: args,
+                            ko: b,
+                            ok: a,
+                            v: 1,
+                        });
+                    }
+                    return 0;
+                });
+            };
+        _window.document.head.appendChild(scriptElement);
+    });
+};
+/**
+ * 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
+ * ```
+ * @param hooks Hooks to be called when SDK is ready or a survey is showed, started, completed, hidden
+ * or when a question is replied.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.init(
+ *   "<your-website-id>",
+ *   "<your-user-id>",
+ *   {
+ *     firstname: '<user-firstname>',
+ *     lastname: '<user-lastname>',
+ *     plan: '<user-plan>',
+ *     last_seen_at: new Date(),
+ *     authenticated: true
+ *   },
+ *   {
+ *     version: "1.0.0",
+ *     onReady: (payload) =>  console.log("Screeb SDK is ready!", payload),
+ *   },
+ * );
+ * ```
+ */
+var init = function (websiteId, userId, userProperties, hooks) {
+    var identityObject;
+    if (userId || userProperties) {
+        identityObject = {
+            hooks: hooks,
+            identity: {
+                id: userId,
+                properties: userProperties,
+            },
+        };
+    }
+    return callScreebCommand("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 (_window === null || _window === void 0 ? void 0 : _window.$screeb) && typeof _window.$screeb === "function";
+};
+/**
+ * Shutdowns current Screeb session.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.close();
+ * ```
+ */
+var close = function () { return callScreebCommand("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 callScreebCommand("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
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * 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(),
+ *   }
+ * );
+ * ```
+ */
+var eventTrack = function (eventName, eventProperties) { return callScreebCommand("event.track", 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
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.identity(
+ *   "<your-user-id>",
+ *   {
+ *     firstname: '<user-firstname>',
+ *     lastname: '<user-lastname>',
+ *     plan: '<user-plan>',
+ *     last_seen_at: new Date(),
+ *     authenticated: true
+ *   }
+ * );
+ * ```
+ */
+var identity = function (userId, userProperties) {
+    return callScreebCommand("identity", userId, userProperties);
+};
+/**
+ * Retrieves the current user 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 callScreebCommand("identity.get");
+};
+/**
+ * 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
+ * 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 callScreebCommand("identity.group.assign", groupType, groupName, 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
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.identityGroupUnassign('company', 'Apple');
+ * ```
+ */
+var identityGroupUnassign = function (groupName, groupType) {
+    return callScreebCommand("identity.group.unassign", groupType, groupName);
+};
+/**
+ * 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
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * // Set user properties
+ * 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
+ * Screeb.identityProperties(
+ *   {
+ *     age: null,
+ *     company: null,
+ *     logged: true,
+ *   }
+ * );
+ * ```
+ */
+var identityProperties = function (userProperties) {
+    return callScreebCommand("identity.properties", 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
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.identityReset();
+ * ```
+ */
+var identityReset = function () { return callScreebCommand("identity.reset"); };
+/**
+ * Interrupts a running survey.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.surveyClose();
+ * ```
+ */
+var surveyClose = function () { return callScreebCommand("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
+ *   },
+ *   {
+ *     version: "1.0.0",
+ *     onSurveyShowed: (payload) => console.log("Survey showed", payload),
+ *   },
+ * );
+ * ```
+ */
+var surveyStart = function (surveyId, allowMultipleResponses, hiddenFields, hooks) {
+    if (allowMultipleResponses === void 0) { allowMultipleResponses = true; }
+    if (hiddenFields === void 0) { hiddenFields = {}; }
+    return callScreebCommand("survey.start", surveyId, {
+        allow_multiple_responses: allowMultipleResponses,
+        hidden_fields: hiddenFields,
+        hooks: hooks,
+    });
+};
+/**
+ * Forces a targeting check.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.targetingCheck();
+ * ```
+ */
+var targetingCheck = function () { return callScreebCommand("targeting.check"); };
+/**
+ * Prints the current state of the targeting engine.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * console.log(await 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 callScreebCommand("targeting.debug"); };
+
+exports.close = close;
+exports.debug = debug;
+exports.eventTrack = eventTrack;
+exports.identity = identity;
+exports.identityGet = identityGet;
+exports.identityGroupAssign = identityGroupAssign;
+exports.identityGroupUnassign = identityGroupUnassign;
+exports.identityProperties = identityProperties;
+exports.identityReset = identityReset;
+exports.init = init;
+exports.isLoaded = isLoaded;
+exports.load = load;
+exports.surveyClose = surveyClose;
+exports.surveyStart = surveyStart;
+exports.targetingCheck = targetingCheck;
+exports.targetingDebug = targetingDebug;

package/dist/cjs/types.d.ts

@@ -0,0 +1,58 @@
+import { HookOnQuestionReplied, HookOnReady, HookOnSurveyCompleted, HookOnSurveyHidden, HookOnSurveyShowed, HookOnSurveyStarted } from "./hooks.types";
+/** This is property types that are supported by Screeb. */
+export type PropertyType = number | boolean | string | Date | PropertyRecord;
+/** This is a property object that are supported by Screeb. */
+export type PropertyRecord = {
+    [key: string]: PropertyType | PropertyType[];
+};
+/** This is the Screeb tag options object. */
+export type ScreebOptions = {
+    /** If you're running Screeb tag in an iframe, please set the inner window here. */
+    window?: Window;
+    /** Please don't do this. */
+    screebEndpoint?: string;
+};
+export type ScreebFunction = (..._: unknown[]) => void | Promise<unknown>;
+/** This is the Screeb object publicly exposed in browser `window`. */
+export type ScreebObject = ScreebFunction & {
+    q?: {
+        args: unknown[];
+        ko: (reason?: unknown) => void;
+        ok: (value?: unknown) => void;
+        v: number;
+    }[];
+};
+/** This is the object returned by the function `identityGet()`. */
+export type ScreebIdentityGetReturn = {
+    /** Anonymous id given to each user */
+    anonymous_id: string;
+    /** The authenticated id assigned to the user. */
+    user_id: string;
+    /** The current user session id */
+    session_id: string;
+    /** The current user session start time */
+    session_start: string;
+    /** The current user session end time */
+    session_end: string;
+    /** The current channel id with which the tag was initialized */
+    channel_id: string;
+    /** `true` if the tag is loaded, initialized and ready to rock */
+    is_ready: boolean;
+};
+/** This is the Screeb tag hooks object. */
+export type Hooks = {
+    /** This defines the version of hooks and their data */
+    version: string;
+    /** This hook is triggered when Screeb SD is loaded, initialized and ready to rock */
+    onReady?: HookOnReady;
+    /** This hook is triggered when a survey is displayed on screen (also triggered when page is reloaded) */
+    onSurveyShowed?: HookOnSurveyShowed;
+    /** This hook is triggered when a survey is started */
+    onSurveyStarted?: HookOnSurveyStarted;
+    /** This hook is triggered when a question is answered */
+    onQuestionReplied?: HookOnQuestionReplied;
+    /** This hook is triggered when a survey is completed */
+    onSurveyCompleted?: HookOnSurveyCompleted;
+    /** This hook is triggered when a survey is hidden */
+    onSurveyHidden?: HookOnSurveyHidden;
+};

package/dist/es/index.d.ts

@@ -1,5 +1,6 @@
 import { Hooks, PropertyRecord, ScreebIdentityGetReturn, ScreebOptions } from "./types";
 export * from "./types";
+export * from "./hooks.types";
 /**
  * Appends Screeb tag into your dom.
  *

package/docs/README.md

@@ -6,13 +6,31 @@
 
 ### Type Aliases
 
+- [Channel](README.md#channel)
+- [ChannelType](README.md#channeltype)
+- [HookCommonProperties](README.md#hookcommonproperties)
+- [HookOnQuestionReplied](README.md#hookonquestionreplied)
+- [HookOnReady](README.md#hookonready)
+- [HookOnSurveyCompleted](README.md#hookonsurveycompleted)
+- [HookOnSurveyHidden](README.md#hookonsurveyhidden)
+- [HookOnSurveyShowed](README.md#hookonsurveyshowed)
+- [HookOnSurveyStarted](README.md#hookonsurveystarted)
 - [Hooks](README.md#hooks)
 - [PropertyRecord](README.md#propertyrecord)
 - [PropertyType](README.md#propertytype)
+- [ResponseItem](README.md#responseitem)
+- [ResponseItemAnswer](README.md#responseitemanswer)
+- [ResponseItemQuestion](README.md#responseitemquestion)
+- [ResponseStatus](README.md#responsestatus)
 - [ScreebFunction](README.md#screebfunction)
 - [ScreebIdentityGetReturn](README.md#screebidentitygetreturn)
 - [ScreebObject](README.md#screebobject)
 - [ScreebOptions](README.md#screeboptions)
+- [Survey](README.md#survey)
+- [SurveyFormat](README.md#surveyformat)
+- [SurveyPosition](README.md#surveyposition)
+- [SurveySize](README.md#surveysize)
+- [User](README.md#user)
 
 ### Functions
 
@@ -35,6 +53,161 @@
 
 ## Type Aliases
 
+### Channel
+
+Ƭ **Channel**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `id` | `string` |
+| `type` | [`ChannelType`](README.md#channeltype) |
+
+___
+
+### ChannelType
+
+Ƭ **ChannelType**: ``"widget"`` \| ``"ios"`` \| ``"android"``
+
+___
+
+### HookCommonProperties
+
+Ƭ **HookCommonProperties**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `channel` | [`Channel`](README.md#channel) |
+| `survey` | [`Survey`](README.md#survey) |
+| `user` | [`User`](README.md#user) |
+
+___
+
+### HookOnQuestionReplied
+
+Ƭ **HookOnQuestionReplied**: (`data`: [`HookCommonProperties`](README.md#hookcommonproperties) & { `response`: { `answer`: [`ResponseItemAnswer`](README.md#responseitemanswer) ; `id`: `string` ; `items`: [`ResponseItem`](README.md#responseitem)[] ; `question`: [`ResponseItemQuestion`](README.md#responseitemquestion) ; `status`: ``null``  }  }) => `void`
+
+#### Type declaration
+
+▸ (`data`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | [`HookCommonProperties`](README.md#hookcommonproperties) & { `response`: { `answer`: [`ResponseItemAnswer`](README.md#responseitemanswer) ; `id`: `string` ; `items`: [`ResponseItem`](README.md#responseitem)[] ; `question`: [`ResponseItemQuestion`](README.md#responseitemquestion) ; `status`: ``null``  }  } |
+
+##### Returns
+
+`void`
+
+___
+
+### HookOnReady
+
+Ƭ **HookOnReady**: (`data`: { `channel`: [`Channel`](README.md#channel) ; `user`: [`User`](README.md#user)  }) => `void`
+
+#### Type declaration
+
+▸ (`data`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | `Object` |
+| `data.channel` | [`Channel`](README.md#channel) |
+| `data.user` | [`User`](README.md#user) |
+
+##### Returns
+
+`void`
+
+___
+
+### HookOnSurveyCompleted
+
+Ƭ **HookOnSurveyCompleted**: (`data`: [`HookCommonProperties`](README.md#hookcommonproperties) & { `response`: { `id`: `string` ; `items`: [`ResponseItem`](README.md#responseitem)[]  }  }) => `void`
+
+#### Type declaration
+
+▸ (`data`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | [`HookCommonProperties`](README.md#hookcommonproperties) & { `response`: { `id`: `string` ; `items`: [`ResponseItem`](README.md#responseitem)[]  }  } |
+
+##### Returns
+
+`void`
+
+___
+
+### HookOnSurveyHidden
+
+Ƭ **HookOnSurveyHidden**: (`data`: [`HookCommonProperties`](README.md#hookcommonproperties) & { `response`: { `hide_reason`: [`ResponseStatus`](README.md#responsestatus) ; `id`: `string` ; `items`: [`ResponseItem`](README.md#responseitem)[]  }  }) => `void`
+
+#### Type declaration
+
+▸ (`data`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | [`HookCommonProperties`](README.md#hookcommonproperties) & { `response`: { `hide_reason`: [`ResponseStatus`](README.md#responsestatus) ; `id`: `string` ; `items`: [`ResponseItem`](README.md#responseitem)[]  }  } |
+
+##### Returns
+
+`void`
+
+___
+
+### HookOnSurveyShowed
+
+Ƭ **HookOnSurveyShowed**: (`data`: [`HookCommonProperties`](README.md#hookcommonproperties) & { `response`: { `id`: `string` ; `items`: [`ResponseItem`](README.md#responseitem)[]  }  }) => `void`
+
+#### Type declaration
+
+▸ (`data`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | [`HookCommonProperties`](README.md#hookcommonproperties) & { `response`: { `id`: `string` ; `items`: [`ResponseItem`](README.md#responseitem)[]  }  } |
+
+##### Returns
+
+`void`
+
+___
+
+### HookOnSurveyStarted
+
+Ƭ **HookOnSurveyStarted**: (`data`: [`HookCommonProperties`](README.md#hookcommonproperties) & { `response`: { `id`: `string`  }  }) => `void`
+
+#### Type declaration
+
+▸ (`data`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | [`HookCommonProperties`](README.md#hookcommonproperties) & { `response`: { `id`: `string`  }  } |
+
+##### Returns
+
+`void`
+
+___
+
 ### Hooks
 
 Ƭ **Hooks**: `Object`
@@ -45,12 +218,12 @@ This is the Screeb tag hooks object.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `onQuestionReplied?` | `HookOnQuestionReplied` | This hook is triggered when a question is answered |
-| `onReady?` | `HookOnReady` | This hook is triggered when Screeb SD is loaded, initialized and ready to rock |
-| `onSurveyCompleted?` | `HookOnSurveyCompleted` | This hook is triggered when a survey is completed |
-| `onSurveyHidden?` | `HookOnSurveyHidden` | This hook is triggered when a survey is hidden |
-| `onSurveyShowed?` | `HookOnSurveyShowed` | This hook is triggered when a survey is displayed on screen (also triggered when page is reloaded) |
-| `onSurveyStarted?` | `HookOnSurveyStarted` | This hook is triggered when a survey is started |
+| `onQuestionReplied?` | [`HookOnQuestionReplied`](README.md#hookonquestionreplied) | This hook is triggered when a question is answered |
+| `onReady?` | [`HookOnReady`](README.md#hookonready) | This hook is triggered when Screeb SD is loaded, initialized and ready to rock |
+| `onSurveyCompleted?` | [`HookOnSurveyCompleted`](README.md#hookonsurveycompleted) | This hook is triggered when a survey is completed |
+| `onSurveyHidden?` | [`HookOnSurveyHidden`](README.md#hookonsurveyhidden) | This hook is triggered when a survey is hidden |
+| `onSurveyShowed?` | [`HookOnSurveyShowed`](README.md#hookonsurveyshowed) | This hook is triggered when a survey is displayed on screen (also triggered when page is reloaded) |
+| `onSurveyStarted?` | [`HookOnSurveyStarted`](README.md#hookonsurveystarted) | This hook is triggered when a survey is started |
 | `version` | `string` | This defines the version of hooks and their data |
 
 ___
@@ -75,6 +248,53 @@ This is property types that are supported by Screeb.
 
 ___
 
+### ResponseItem
+
+Ƭ **ResponseItem**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `answer` | [`ResponseItemAnswer`](README.md#responseitemanswer) |
+| `question` | [`ResponseItemQuestion`](README.md#responseitemquestion) |
+
+___
+
+### ResponseItemAnswer
+
+Ƭ **ResponseItemAnswer**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `fields?` | { `boolean?`: `boolean` ; `number?`: `number` ; `text?`: `string` ; `time?`: `string` ; `type`: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"none"`` \| ``"time"`` \| ``"file"``  }[] |
+| `replied_at?` | `string` |
+
+___
+
+### ResponseItemQuestion
+
+Ƭ **ResponseItemQuestion**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `id` | `string` |
+| `title` | `string` |
+| `type` | ``"text"`` \| ``"video"`` |
+| `url?` | `string` |
+
+___
+
+### ResponseStatus
+
+Ƭ **ResponseStatus**: ``"displayed"`` \| ``"started"`` \| ``"ended"`` \| ``"closed"`` \| ``"interrupted"``
+
+___
+
 ### ScreebFunction
 
 Ƭ **ScreebFunction**: (...`_`: `unknown`[]) => `void` \| `Promise`<`unknown`\>
@@ -136,6 +356,52 @@ This is the Screeb tag options object.
 | `screebEndpoint?` | `string` | Please don't do this. |
 | `window?` | `Window` | If you're running Screeb tag in an iframe, please set the inner window here. |
 
+___
+
+### Survey
+
+Ƭ **Survey**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `id` | `string` |
+| `survey_format` | [`SurveyFormat`](README.md#surveyformat) |
+| `survey_position` | [`SurveyPosition`](README.md#surveyposition) |
+| `survey_size` | ``100`` |
+
+___
+
+### SurveyFormat
+
+Ƭ **SurveyFormat**: ``"conversationnal"`` \| ``"cards"``
+
+___
+
+### SurveyPosition
+
+Ƭ **SurveyPosition**: ``"center-left"`` \| ``"center-center"`` \| ``"center-right"`` \| ``"bottom-left"`` \| ``"bottom-center"`` \| ``"bottom-right"``
+
+___
+
+### SurveySize
+
+Ƭ **SurveySize**: ``25`` \| ``50`` \| ``75`` \| ``100`` \| ``125`` \| ``150``
+
+___
+
+### User
+
+Ƭ **User**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `anonymous_id` | `string` |
+| `userId?` | `string` |
+
 ## Functions
 
 ### close

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@screeb/sdk-browser",
-  "version": "0.1.11",
+  "version": "0.1.13",
   "description": "Screeb's browser sdk.",
   "keywords": [
     "product discovery",
@@ -25,13 +25,8 @@
   "author": "Screeb's frontend team",
   "sideEffects": false,
   "type": "module",
-  "exports": {
-    "./package.json": "./package.json",
-    ".": {
-      "import": "./dist/es/index.js"
-    }
-  },
   "module": "dist/es/index.js",
+  "main": "dist/cjs/index.js",
   "types": "dist/es/index.d.ts",
   "files": [
     "dist",
@@ -43,11 +38,11 @@
     "build:doc": "typedoc src/index.ts",
     "clean": "rm -Rf dist",
     "lint": "eslint .",
-    "test": "jest"
+    "test": "echo 'test disabled'"
   },
   "devDependencies": {
     "@screeb/eslint-config": "^0.1.6",
-    "@screeb/typescript-config": "^0.1.6",
+    "@screeb/typescript-config": "^0.1.8",
     "@types/jest": "^29.5.5",
     "@types/node": "^20.8.4",
     "@typescript-eslint/eslint-plugin": "^6.7.5",