@screeb/sdk-browser 0.1.12 → 0.1.13

package/dist/es/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/es/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/es/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@screeb/sdk-browser",
-  "version": "0.1.12",
+  "version": "0.1.13",
   "description": "Screeb's browser sdk.",
   "keywords": [
     "product discovery",
@@ -25,23 +25,9 @@
   "author": "Screeb's frontend team",
   "sideEffects": false,
   "type": "module",
-  "exports": {
-    "./package.json": "./package.json",
-    ".": {
-      "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.es.js"
-      },
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.cjs.js"
-      }
-    }
-  },
-  "module": "dist/index.es.js",
-  "main": "dist/index.cjs.js",
-  "jsnext:main": "dist/index.es.js",
-  "types": "dist/index.d.ts",
+  "module": "dist/es/index.js",
+  "main": "dist/cjs/index.js",
+  "types": "dist/es/index.d.ts",
   "files": [
     "dist",
     "docs",
@@ -56,7 +42,7 @@
   },
   "devDependencies": {
     "@screeb/eslint-config": "^0.1.6",
-    "@screeb/typescript-config": "^0.1.7",
+    "@screeb/typescript-config": "^0.1.8",
     "@types/jest": "^29.5.5",
     "@types/node": "^20.8.4",
     "@typescript-eslint/eslint-plugin": "^6.7.5",