@screeb/sdk-angular 0.1.1

package/dist/es/screeb.d.ts

@@ -0,0 +1,301 @@
+import * as _Screeb from "@screeb/sdk-browser";
+import { ScreebConfig } from "./screeb-config";
+export declare class Screeb {
+    private config;
+    private isInitialized;
+    constructor(config: ScreebConfig);
+    private ensureScreeb;
+    /**
+     * Shutdowns current Screeb session.
+     *
+     * @example
+     * ```ts
+     * this.screeb.close();
+     * ```
+     */
+    close(): Promise<unknown>;
+    /**
+     * 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
+     * // **************************************************************
+     * ```
+     */
+    debug(): 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
+     * 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(),
+     *   }
+     * );
+     * ```
+     */
+    eventTrack(eventName: string, eventProperties?: _Screeb.PropertyRecord): 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
+     * this.screeb.identity(
+     *   "<your-user-id>",
+     *   {
+     *     firstname: '<user-firstname>',
+     *     lastname: '<user-lastname>',
+     *     plan: '<user-plan>',
+     *     last_seen_at: new Date(),
+     *     authenticated: true
+     *   }
+     * );
+     * ```
+     */
+    identity(userId: string, userProperties?: _Screeb.PropertyRecord): Promise<unknown>;
+    /**
+     * 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,
+     * // }
+     * ```
+     */
+    identityGet(): Promise<_Screeb.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
+     * 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',
+     *   }
+     * );
+     * ```
+     */
+    identityGroupAssign(groupName: string, groupType?: string, groupProperties?: _Screeb.PropertyRecord): 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
+     * this.screeb.identityGroupUnassign('company', 'Apple');
+     * ```
+     */
+    identityGroupUnassign(groupName: string, groupType?: string): 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
+     * // 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,
+     *   }
+     * );
+     * ```
+     */
+    identityProperties(userProperties: _Screeb.PropertyRecord): 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
+     * this.screeb.identityReset();
+     * ```
+     */
+    identityReset(): Promise<unknown>;
+    /**
+     * Interrupts a running survey.
+     *
+     * @example
+     * ```ts
+     * this.screeb.surveyClose();
+     * ```
+     */
+    surveyClose(): Promise<unknown>;
+    /**
+     * Starts a survey by its ID.
+     *
+     * @example
+     * ```ts
+     * this.screeb.surveyStart(
+     *   '<UUID>',
+     *   false,
+     *   {
+     *     color: "green",
+     *     article_id: 42
+     *   }
+     * );
+     * ```
+     */
+    surveyStart(surveyId: string, allowMultipleResponses: boolean, hiddenFields: _Screeb.PropertyRecord): Promise<unknown>;
+    /**
+     * Forces a targeting check.
+     *
+     * @example
+     * ```ts
+     * this.screeb.targetingCheck();
+     * ```
+     */
+    targetingCheck(): Promise<unknown>;
+    /**
+     * 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 🔴
+     * ```
+     */
+    targetingDebug(): Promise<unknown>;
+    /**
+     * 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
+     *   }
+     * );
+     * ```
+     */
+    init(websiteId: string, userId?: string, userProperties?: _Screeb.PropertyRecord): Promise<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
+     * this.screeb.load();
+     * ```
+     */
+    load(): Promise<undefined>;
+}

package/dist/es/screeb.module.d.ts

@@ -0,0 +1,27 @@
+import { ModuleWithProviders } from "@angular/core";
+import { Screeb } from "./screeb";
+import { ScreebConfig } from "./screeb-config";
+export declare class 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
+     *   }
+     * })
+     * ```
+     */
+    static forRoot(config: ScreebConfig): ModuleWithProviders<ScreebModule>;
+    constructor(config: ScreebConfig, screeb: Screeb);
+}

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.

package/docs/README.md

@@ -0,0 +1,11 @@
+@screeb/sdk-angular
+
+# @screeb/sdk-angular
+
+## Table of contents
+
+### Classes
+
+- [Screeb](classes/Screeb.md)
+- [ScreebConfig](classes/ScreebConfig.md)
+- [ScreebModule](classes/ScreebModule.md)