@screeb/sdk-browser 0.1.2

package/README.md

@@ -0,0 +1,9 @@
+# `@screeb/sdk-browser`
+
+Screeb's browser sdk.
+
+Visit [our homepage](https://screeb.app/).
+
+See [Documentation generated from source files by Typedoc](./docs/README.md).
+
+See [out developper documentation](https://github.com/ScreebApp/developers).

package/dist/es/index.d.ts

@@ -0,0 +1,386 @@
+/** 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;
+};
+type ScreebFunction = (..._: unknown[]) => void | Promise<unknown>;
+export type ScreebObject = ScreebFunction & {
+    q?: unknown[][];
+};
+/**
+ * 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 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
+ *   }
+ * );
+ * ```
+ */
+export declare const init: (websiteId: string, visitorId?: string, visitorProperties?: PropertyRecord) => 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;
+/**
+ * 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 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(),
+ *   }
+ * );
+ * ```
+ */
+export declare const eventTrack: (eventName: string, eventProperties?: PropertyRecord) => void | Promise<unknown>;
+/**
+ * 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
+ *   }
+ * );
+ * ```
+ */
+export declare const identity: (visitorId: string, visitorProperties?: PropertyRecord) => void | Promise<unknown>;
+type ScreebIdentityGetReturn = {
+    anonymous_id: string;
+    user_id: string;
+    session_id: string;
+    session_start: string;
+    session_end: string;
+    channel_id: string;
+    is_ready: boolean;
+};
+/**
+ * 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,
+ * // }
+ * ```
+ */
+export declare const identityGet: () => Promise<ScreebIdentityGetReturn>;
+/**
+ * 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',
+ *   }
+ * );
+ * ```
+ */
+export declare const identityGroupAssign: (groupName: string, groupType?: string, groupProperties?: PropertyRecord) => void | Promise<unknown>;
+/**
+ * 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');
+ * ```
+ */
+export declare const identityGroupUnassign: (groupName: string, groupType?: string) => void | Promise<unknown>;
+/**
+ * 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,
+ *   }
+ * );
+ * ```
+ */
+export declare const identityProperties: (visitorProperties: PropertyRecord) => void | Promise<unknown>;
+/**
+ * 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();
+ * ```
+ */
+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
+ *   }
+ * );
+ * ```
+ */
+export declare const surveyStart: (surveyId: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord) => 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";
+ *
+ * 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>;
+/**
+ * Starts the targeting engine.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.targetingStart();
+ * ```
+ */
+export declare const targetingStart: () => void | Promise<unknown>;
+/**
+ * Stops the targeting engine.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.targetingStop();
+ * ```
+ */
+export declare const targetingStop: () => void | Promise<unknown>;
+export {};