@screeb/sdk-browser 0.1.2 → 0.1.4

package/README.md

@@ -1,9 +1,58 @@
-# `@screeb/sdk-browser`
+<p align="center">
+  <a href="https://screeb.app" alt="Intercom">
+    <img src="https://raw.githubusercontent.com/ScreebApp/sdk-js/master/packages/screeb-sdk-browser/readme/screeb-logo.svg?token=GHSAT0AAAAAAB2OOPMGT2QD5TL3IRJN3CKCZDEYHJA" alt="Logo" height="120px" style="margin-top: 20px;"/>
+  </a>
+</p>
+<h1 align="center">@screeb/sdk-browser</h1>
+<p align="center">
+  Screeb's browser sdk.
 
-Screeb's browser sdk.
+  <b>Continuous Product Discovery, Without the Time Sink.</b>
 
-Visit [our homepage](https://screeb.app/).
+  <a href="https://screeb.app" alt="Intercom">Screeb</a> is the only Continuous Product Discovery platform that lets you analyse users' behaviour, ask in-app questions, recruit people for interviews and analyse data in a blink with AI.
+</p>
 
-See [Documentation generated from source files by Typedoc](./docs/README.md).
+<p align="center">
+<a href="https://github.com/ScreebApp/sdk-js/actions/workflows/node.js.yml" alt="ci">
+  <img alt="ci" src="https://github.com/ScreebApp/sdk-js/actions/workflows/node.js.yml/badge.svg">
+</a>
+<img alt="version" src="https://img.shields.io/npm/v/@screeb/sdk-browser.svg" />
+<img alt="minzipped size" src="https://badgen.net/bundlephobia/minzip/@screeb/sdk-browser">
+<img alt="downloads" src="https://badgen.net/npm/dw/@screeb/sdk-browser" />
+</p>
 
-See [out developper documentation](https://github.com/ScreebApp/developers).
+
+## Installation
+
+This library is published in the NPM registry and can be installed using any compatible package manager.
+
+```bash
+npm install @screeb/sdk-browser --save
+
+# For Yarn, use the command below.
+yarn add @screeb/sdk-browser
+```
+
+## Usage
+
+Basic usage:
+```ts
+import * as Screeb from "@screeb/sdk-browser";
+
+Screeb.load();
+Screeb.init('<your-website-id>');
+```
+
+For a more advanced usage and a complete API documentation, see [documentation generated from source files](https://github.com/ScreebApp/sdk-js/tree/master/packages/screeb-sdk-browser/docs).
+
+For further information, see [our developper documentation](https://github.com/ScreebApp/developers).
+
+## Support
+For any issues, please contact our support team at support@screeb.com.
+
+## Contributing
+All third party contributors acknowledge that any contributions they provide will be made under the same open source license that the open source project is provided under.
+
+## License
+
+Released under [MIT License](https://github.com/ScreebApp/sdk-js/blob/master/LICENSE).

package/dist/es/index.d.ts

@@ -34,8 +34,8 @@ 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.
+ * @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
@@ -48,7 +48,7 @@ export declare const load: (options?: ScreebOptions) => Promise<undefined>;
  *
  * Screeb.init(
  *   "<your-website-id>",
- *   "<your-visitor-id>",
+ *   "<your-user-id>",
  *   {
  *     firstname: '<user-firstname>',
  *     lastname: '<user-lastname>',
@@ -59,7 +59,7 @@ export declare const load: (options?: ScreebOptions) => Promise<undefined>;
  * );
  * ```
  */
-export declare const init: (websiteId: string, visitorId?: string, visitorProperties?: PropertyRecord) => void | Promise<unknown>;
+export declare const init: (websiteId: string, userId?: string, userProperties?: PropertyRecord) => void | Promise<unknown>;
 /**
  * Checks if Screeb tag has been loaded.
  *
@@ -113,7 +113,7 @@ export declare const close: () => void | Promise<unknown>;
  */
 export declare const debug: () => void | Promise<unknown>;
 /**
- * Tracks a visitor event.
+ * Tracks a user event.
  *
  * @param eventName The event name.
  * @param eventProperties The properties of your event.
@@ -127,8 +127,7 @@ export declare const debug: () => void | Promise<unknown>;
  * ```ts
  * import * as Screeb from "@screeb/sdk-browser";
  *
- * Screeb.init(
- *   "event.track",
+ * Screeb.eventTrack(
  *   "Product added to cart",
  *   {
  *     product_name: 'Red bike 2021',
@@ -146,11 +145,11 @@ export declare const debug: () => void | Promise<unknown>;
  */
 export declare const eventTrack: (eventName: string, eventProperties?: PropertyRecord) => void | Promise<unknown>;
 /**
- * Change the current visitor identity.
+ * Change the current user identity.
  * Warning: Running surveys will be closed.
  *
- * @param visitorId The unique identifier of your visitor.
- * @param visitorProperties The properties of your visitor.
+ * @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
@@ -162,7 +161,7 @@ export declare const eventTrack: (eventName: string, eventProperties?: PropertyR
  * import * as Screeb from "@screeb/sdk-browser";
  *
  * Screeb.identity(
- *   "<your-visitor-id>",
+ *   "<your-user-id>",
  *   {
  *     firstname: '<user-firstname>',
  *     lastname: '<user-lastname>',
@@ -173,7 +172,7 @@ export declare const eventTrack: (eventName: string, eventProperties?: PropertyR
  * );
  * ```
  */
-export declare const identity: (visitorId: string, visitorProperties?: PropertyRecord) => void | Promise<unknown>;
+export declare const identity: (userId: string, userProperties?: PropertyRecord) => void | Promise<unknown>;
 type ScreebIdentityGetReturn = {
     anonymous_id: string;
     user_id: string;
@@ -184,7 +183,7 @@ type ScreebIdentityGetReturn = {
     is_ready: boolean;
 };
 /**
- * Retrieves the current visitor identity.
+ * Retrieves the current user identity.
  *
  * @example
  * ```ts
@@ -204,11 +203,11 @@ type ScreebIdentityGetReturn = {
  */
 export declare const identityGet: () => Promise<ScreebIdentityGetReturn>;
 /**
- * Assigns the current visitor to a group.
+ * Assigns the current user to a group.
  *
  * @param groupName
  * @param groupType
- * @param groupProperties The properties of your visitor group.
+ * @param groupProperties The properties of your user group.
  * ```text Requirements:
  *   - Property names must be limited to 128 characters
  *   - No more than 1000 attributes
@@ -235,10 +234,10 @@ export declare const identityGet: () => Promise<ScreebIdentityGetReturn>;
  */
 export declare const identityGroupAssign: (groupName: string, groupType?: string, groupProperties?: PropertyRecord) => void | Promise<unknown>;
 /**
- * Unassigns the current visitor to a group.
+ * Unassigns the current user to a group.
  *
- * @param groupName The name of your visitor group.
- * @param groupType The type of your visitor group.
+ * @param groupName The name of your user group.
+ * @param groupType The type of your user group.
  *
  * @example
  * ```ts
@@ -249,9 +248,9 @@ export declare const identityGroupAssign: (groupName: string, groupType?: string
  */
 export declare const identityGroupUnassign: (groupName: string, groupType?: string) => void | Promise<unknown>;
 /**
- * Adds properties to the current visitor identity.
+ * Adds properties to the current user identity.
  *
- * @param visitorProperties The properties of your visitor.
+ * @param userProperties The properties of your user.
  * ```text Requirements:
  *   - Property names must be limited to 128 characters
  *   - No more than 1000 attributes
@@ -262,7 +261,7 @@ export declare const identityGroupUnassign: (groupName: string, groupType?: stri
  * ```ts
  * import * as Screeb from "@screeb/sdk-browser";
  *
- * // Set visitor properties
+ * // Set user properties
  * Screeb.identityProperties(
  *   {
  *     firstname: '<user-firstname>',
@@ -273,7 +272,7 @@ export declare const identityGroupUnassign: (groupName: string, groupType?: stri
  *   }
  * );
  *
- * // Delete visitor property : set values to null
+ * // Delete user property : set values to null
  * Screeb.identityProperties(
  *   {
  *     age: null,
@@ -283,9 +282,9 @@ export declare const identityGroupUnassign: (groupName: string, groupType?: stri
  * );
  * ```
  */
-export declare const identityProperties: (visitorProperties: PropertyRecord) => void | Promise<unknown>;
+export declare const identityProperties: (userProperties: PropertyRecord) => void | Promise<unknown>;
 /**
- * Resets the current visitor identity.
+ * Resets the current user identity.
  * Warning: This command must be called only once, since it creates a new identity on Screeb side.
  *
  * @example
@@ -343,7 +342,7 @@ export declare const targetingCheck: () => void | Promise<unknown>;
  * ```ts
  * import * as Screeb from "@screeb/sdk-browser";
  *
- * Screeb.targetingDebug();
+ * console.log(await Screeb.targetingDebug());
  * // targeting ************ SCREEB TARGETING RULES DEBUG **************
  * // Disabled surveys are not listed here.
  * //
@@ -361,26 +360,4 @@ export declare const targetingCheck: () => void | Promise<unknown>;
  * ```
  */
 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 {};

package/dist/es/index.js

@@ -42,8 +42,8 @@ var load = function (options) {
  * Initializes Screeb tag.
  *
  * @param websiteId Your website/channel id.
- * @param visitorId The unique identifier of your visitor.
- * @param visitorProperties The properties of your visitor.
+ * @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
@@ -56,7 +56,7 @@ var load = function (options) {
  *
  * Screeb.init(
  *   "<your-website-id>",
- *   "<your-visitor-id>",
+ *   "<your-user-id>",
  *   {
  *     firstname: '<user-firstname>',
  *     lastname: '<user-lastname>',
@@ -67,13 +67,13 @@ var load = function (options) {
  * );
  * ```
  */
-var init = function (websiteId, visitorId, visitorProperties) {
+var init = function (websiteId, userId, userProperties) {
     var identityObject;
-    if (visitorId || visitorProperties) {
+    if (userId || userProperties) {
         identityObject = {
             identity: {
-                id: visitorId,
-                properties: visitorProperties,
+                id: userId,
+                properties: userProperties,
             },
         };
     }
@@ -132,7 +132,7 @@ var close = function () { return $screeb("close"); };
  */
 var debug = function () { return $screeb("debug"); };
 /**
- * Tracks a visitor event.
+ * Tracks a user event.
  *
  * @param eventName The event name.
  * @param eventProperties The properties of your event.
@@ -146,8 +146,7 @@ var debug = function () { return $screeb("debug"); };
  * ```ts
  * import * as Screeb from "@screeb/sdk-browser";
  *
- * Screeb.init(
- *   "event.track",
+ * Screeb.eventTrack(
  *   "Product added to cart",
  *   {
  *     product_name: 'Red bike 2021',
@@ -165,11 +164,11 @@ var debug = function () { return $screeb("debug"); };
  */
 var eventTrack = function (eventName, eventProperties) { return $screeb("event.track", eventName, eventProperties); };
 /**
- * Change the current visitor identity.
+ * Change the current user identity.
  * Warning: Running surveys will be closed.
  *
- * @param visitorId The unique identifier of your visitor.
- * @param visitorProperties The properties of your visitor.
+ * @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
@@ -181,7 +180,7 @@ var eventTrack = function (eventName, eventProperties) { return $screeb("event.t
  * import * as Screeb from "@screeb/sdk-browser";
  *
  * Screeb.identity(
- *   "<your-visitor-id>",
+ *   "<your-user-id>",
  *   {
  *     firstname: '<user-firstname>',
  *     lastname: '<user-lastname>',
@@ -192,9 +191,11 @@ var eventTrack = function (eventName, eventProperties) { return $screeb("event.t
  * );
  * ```
  */
-var identity = function (visitorId, visitorProperties) { return $screeb("identity", visitorId, visitorProperties); };
+var identity = function (userId, userProperties) {
+    return $screeb("identity", userId, userProperties);
+};
 /**
- * Retrieves the current visitor identity.
+ * Retrieves the current user identity.
  *
  * @example
  * ```ts
@@ -216,11 +217,11 @@ var identityGet = function () {
     return $screeb("identity.get");
 };
 /**
- * Assigns the current visitor to a group.
+ * Assigns the current user to a group.
  *
  * @param groupName
  * @param groupType
- * @param groupProperties The properties of your visitor group.
+ * @param groupProperties The properties of your user group.
  * ```text Requirements:
  *   - Property names must be limited to 128 characters
  *   - No more than 1000 attributes
@@ -247,10 +248,10 @@ var identityGet = function () {
  */
 var identityGroupAssign = function (groupName, groupType, groupProperties) { return $screeb("identity.group.assign", groupType, groupName, groupProperties); };
 /**
- * Unassigns the current visitor to a group.
+ * Unassigns the current user to a group.
  *
- * @param groupName The name of your visitor group.
- * @param groupType The type of your visitor group.
+ * @param groupName The name of your user group.
+ * @param groupType The type of your user group.
  *
  * @example
  * ```ts
@@ -263,9 +264,9 @@ var identityGroupUnassign = function (groupName, groupType) {
     return $screeb("identity.group.unassign", groupType, groupName);
 };
 /**
- * Adds properties to the current visitor identity.
+ * Adds properties to the current user identity.
  *
- * @param visitorProperties The properties of your visitor.
+ * @param userProperties The properties of your user.
  * ```text Requirements:
  *   - Property names must be limited to 128 characters
  *   - No more than 1000 attributes
@@ -276,7 +277,7 @@ var identityGroupUnassign = function (groupName, groupType) {
  * ```ts
  * import * as Screeb from "@screeb/sdk-browser";
  *
- * // Set visitor properties
+ * // Set user properties
  * Screeb.identityProperties(
  *   {
  *     firstname: '<user-firstname>',
@@ -287,7 +288,7 @@ var identityGroupUnassign = function (groupName, groupType) {
  *   }
  * );
  *
- * // Delete visitor property : set values to null
+ * // Delete user property : set values to null
  * Screeb.identityProperties(
  *   {
  *     age: null,
@@ -297,11 +298,11 @@ var identityGroupUnassign = function (groupName, groupType) {
  * );
  * ```
  */
-var identityProperties = function (visitorProperties) {
-    return $screeb("identity.properties", visitorProperties);
+var identityProperties = function (userProperties) {
+    return $screeb("identity.properties", userProperties);
 };
 /**
- * Resets the current visitor identity.
+ * Resets the current user identity.
  * Warning: This command must be called only once, since it creates a new identity on Screeb side.
  *
  * @example
@@ -341,7 +342,7 @@ var surveyClose = function () { return $screeb("survey.close"); };
  * ```
  */
 var surveyStart = function (surveyId, allowMultipleResponses, hiddenFields) {
-    if (allowMultipleResponses === void 0) { allowMultipleResponses = false; }
+    if (allowMultipleResponses === void 0) { allowMultipleResponses = true; }
     if (hiddenFields === void 0) { hiddenFields = {}; }
     return $screeb("survey.start", surveyId, {
         allow_multiple_responses: allowMultipleResponses,
@@ -366,7 +367,7 @@ var targetingCheck = function () { return $screeb("targeting.check"); };
  * ```ts
  * import * as Screeb from "@screeb/sdk-browser";
  *
- * Screeb.targetingDebug();
+ * console.log(await Screeb.targetingDebug());
  * // targeting ************ SCREEB TARGETING RULES DEBUG **************
  * // Disabled surveys are not listed here.
  * //
@@ -384,27 +385,5 @@ var targetingCheck = function () { return $screeb("targeting.check"); };
  * ```
  */
 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 };
+export { close, debug, eventTrack, identity, identityGet, identityGroupAssign, identityGroupUnassign, identityProperties, identityReset, init, isLoaded, load, surveyClose, surveyStart, targetingCheck, targetingDebug };

package/docs/README.md

@@ -29,8 +29,6 @@
 - [surveyStart](README.md#surveystart)
 - [targetingCheck](README.md#targetingcheck)
 - [targetingDebug](README.md#targetingdebug)
-- [targetingStart](README.md#targetingstart)
-- [targetingStop](README.md#targetingstop)
 
 ## Type Aliases
 
@@ -136,15 +134,14 @@ ___
 
 ▸ **eventTrack**(`eventName`, `eventProperties?`): `void` \| `Promise`<`unknown`\>
 
-Tracks a visitor event.
+Tracks a user event.
 
 **`Example`**
 
 ```ts
 import * as Screeb from "@screeb/sdk-browser";
 
-Screeb.init(
-  "event.track",
+Screeb.eventTrack(
   "Product added to cart",
   {
     product_name: 'Red bike 2021',
@@ -175,9 +172,9 @@ ___
 
 ### identity
 
-▸ **identity**(`visitorId`, `visitorProperties?`): `void` \| `Promise`<`unknown`\>
+▸ **identity**(`userId`, `userProperties?`): `void` \| `Promise`<`unknown`\>
 
-Change the current visitor identity.
+Change the current user identity.
 Warning: Running surveys will be closed.
 
 **`Example`**
@@ -186,7 +183,7 @@ Warning: Running surveys will be closed.
 import * as Screeb from "@screeb/sdk-browser";
 
 Screeb.identity(
-  "<your-visitor-id>",
+  "<your-user-id>",
   {
     firstname: '<user-firstname>',
     lastname: '<user-lastname>',
@@ -201,8 +198,8 @@ Screeb.identity(
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `visitorId` | `string` | The unique identifier of your visitor. |
-| `visitorProperties?` | [`PropertyRecord`](README.md#propertyrecord) | 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. ``` |
+| `userId` | `string` | The unique identifier of your user. |
+| `userProperties?` | [`PropertyRecord`](README.md#propertyrecord) | 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. ``` |
 
 #### Returns
 
@@ -214,7 +211,7 @@ ___
 
 ▸ **identityGet**(): `Promise`<`ScreebIdentityGetReturn`\>
 
-Retrieves the current visitor identity.
+Retrieves the current user identity.
 
 **`Example`**
 
@@ -243,7 +240,7 @@ ___
 
 ▸ **identityGroupAssign**(`groupName`, `groupType?`, `groupProperties?`): `void` \| `Promise`<`unknown`\>
 
-Assigns the current visitor to a group.
+Assigns the current user to a group.
 
 **`Example`**
 
@@ -270,7 +267,7 @@ Screeb.identityGroupAssign(
 | :------ | :------ | :------ |
 | `groupName` | `string` |  |
 | `groupType?` | `string` |  |
-| `groupProperties?` | [`PropertyRecord`](README.md#propertyrecord) | 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. ``` |
+| `groupProperties?` | [`PropertyRecord`](README.md#propertyrecord) | 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. ``` |
 
 #### Returns
 
@@ -282,7 +279,7 @@ ___
 
 ▸ **identityGroupUnassign**(`groupName`, `groupType?`): `void` \| `Promise`<`unknown`\>
 
-Unassigns the current visitor to a group.
+Unassigns the current user to a group.
 
 **`Example`**
 
@@ -296,8 +293,8 @@ Screeb.identityGroupUnassign('company', 'Apple');
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `groupName` | `string` | The name of your visitor group. |
-| `groupType?` | `string` | The type of your visitor group. |
+| `groupName` | `string` | The name of your user group. |
+| `groupType?` | `string` | The type of your user group. |
 
 #### Returns
 
@@ -307,16 +304,16 @@ ___
 
 ### identityProperties
 
-▸ **identityProperties**(`visitorProperties`): `void` \| `Promise`<`unknown`\>
+▸ **identityProperties**(`userProperties`): `void` \| `Promise`<`unknown`\>
 
-Adds properties to the current visitor identity.
+Adds properties to the current user identity.
 
 **`Example`**
 
 ```ts
 import * as Screeb from "@screeb/sdk-browser";
 
-// Set visitor properties
+// Set user properties
 Screeb.identityProperties(
   {
     firstname: '<user-firstname>',
@@ -327,7 +324,7 @@ Screeb.identityProperties(
   }
 );
 
-// Delete visitor property : set values to null
+// Delete user property : set values to null
 Screeb.identityProperties(
   {
     age: null,
@@ -341,7 +338,7 @@ Screeb.identityProperties(
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `visitorProperties` | [`PropertyRecord`](README.md#propertyrecord) | 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. ``` |
+| `userProperties` | [`PropertyRecord`](README.md#propertyrecord) | 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. ``` |
 
 #### Returns
 
@@ -353,7 +350,7 @@ ___
 
 ▸ **identityReset**(): `void` \| `Promise`<`unknown`\>
 
-Resets the current visitor identity.
+Resets the current user identity.
 Warning: This command must be called only once, since it creates a new identity on Screeb side.
 
 **`Example`**
@@ -372,7 +369,7 @@ ___
 
 ### init
 
-▸ **init**(`websiteId`, `visitorId?`, `visitorProperties?`): `void` \| `Promise`<`unknown`\>
+▸ **init**(`websiteId`, `userId?`, `userProperties?`): `void` \| `Promise`<`unknown`\>
 
 Initializes Screeb tag.
 
@@ -383,7 +380,7 @@ import * as Screeb from "@screeb/sdk-browser";
 
 Screeb.init(
   "<your-website-id>",
-  "<your-visitor-id>",
+  "<your-user-id>",
   {
     firstname: '<user-firstname>',
     lastname: '<user-lastname>',
@@ -399,8 +396,8 @@ Screeb.init(
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `websiteId` | `string` | Your website/channel id. |
-| `visitorId?` | `string` | The unique identifier of your visitor. |
-| `visitorProperties?` | [`PropertyRecord`](README.md#propertyrecord) | 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 ``` |
+| `userId?` | `string` | The unique identifier of your user. |
+| `userProperties?` | [`PropertyRecord`](README.md#propertyrecord) | 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 ``` |
 
 #### Returns
 
@@ -502,7 +499,7 @@ Screeb.surveyStart(
 | Name | Type | Default value |
 | :------ | :------ | :------ |
 | `surveyId` | `string` | `undefined` |
-| `allowMultipleResponses` | `boolean` | `false` |
+| `allowMultipleResponses` | `boolean` | `true` |
 | `hiddenFields` | [`PropertyRecord`](README.md#propertyrecord) | `{}` |
 
 #### Returns
@@ -542,7 +539,7 @@ Prints the current state of the targeting engine.
 ```ts
 import * as Screeb from "@screeb/sdk-browser";
 
-Screeb.targetingDebug();
+console.log(await Screeb.targetingDebug());
 // targeting ************ SCREEB TARGETING RULES DEBUG **************
 // Disabled surveys are not listed here.
 //
@@ -562,43 +559,3 @@ Screeb.targetingDebug();
 #### Returns
 
 `void` \| `Promise`<`unknown`\>
-
-___
-
-### targetingStart
-
-▸ **targetingStart**(): `void` \| `Promise`<`unknown`\>
-
-Starts the targeting engine.
-
-**`Example`**
-
-```ts
-import * as Screeb from "@screeb/sdk-browser";
-
-Screeb.targetingStart();
-```
-
-#### Returns
-
-`void` \| `Promise`<`unknown`\>
-
-___
-
-### targetingStop
-
-▸ **targetingStop**(): `void` \| `Promise`<`unknown`\>
-
-Stops the targeting engine.
-
-**`Example`**
-
-```ts
-import * as Screeb from "@screeb/sdk-browser";
-
-Screeb.targetingStop();
-```
-
-#### Returns
-
-`void` \| `Promise`<`unknown`\>

package/package.json

@@ -1,18 +1,36 @@
 {
   "name": "@screeb/sdk-browser",
-  "version": "0.1.2",
-  "author": "Screeb's frontend team",
+  "version": "0.1.4",
   "description": "Screeb's browser sdk.",
-  "license": "ISC",
-  "scripts": {
-    "lint": "eslint .",
-    "build": "rollup -c ./node_modules/@screeb/typescript-config/src/rollup.config.js",
-    "build:doc": "typedoc src/index.ts",
-    "clean": "rm -Rf dist",
-    "test": "jest"
+  "keywords": [
+    "product discovery",
+    "product management",
+    "survey",
+    "analytics",
+    "user feedback",
+    "user voice",
+    "user research"
+  ],
+  "homepage": "https://screeb.app",
+  "bugs": {
+    "url": "https://github.com/ScreebApp/sdk-js/issues",
+    "email": "suuport@screeb.app"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ScreebApp/sdk-js.git",
+    "directory": "packages/screeb-sdk-browser"
   },
+  "license": "MIT",
+  "author": "Screeb's frontend team",
   "sideEffects": false,
   "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": "./dist/es/index.js"
+    }
+  },
   "module": "dist/es/index.js",
   "types": "dist/es/index.d.ts",
   "files": [
@@ -20,15 +38,14 @@
     "docs",
     "README.md"
   ],
-  "exports": {
-    "./package.json": "./package.json",
-    ".": {
-      "import": "./dist/es/index.js"
-    }
+  "scripts": {
+    "build": "rollup -c ./node_modules/@screeb/typescript-config/src/rollup.config.js",
+    "build:doc": "typedoc src/index.ts",
+    "clean": "rm -Rf dist",
+    "lint": "eslint .",
+    "test": "jest"
   },
-  "dependencies": {
-    "@screeb/eslint-config": "^0.1.1",
-    "@screeb/typescript-config": "^0.1.1",
+  "devDependencies": {
     "@types/jest": "^29.5.1",
     "@types/node": "^18.16.3",
     "@typescript-eslint/eslint-plugin": "^5.59.2",
@@ -44,5 +61,8 @@
     "ts-jest": "^29.1.0",
     "typedoc": "^0.24.6",
     "typedoc-plugin-markdown": "^3.15.3"
+  },
+  "publishConfig": {
+    "access": "public"
   }
 }