npm - @screeb/sdk-browser - Versions diffs - 0.1.16 → 0.1.17 - Mend

@screeb/sdk-browser 0.1.16 → 0.1.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/dist/cjs/index.cjs CHANGED Viewed

@@ -1,5 +1,38 @@
 'use strict';
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+/* global Reflect, Promise, SuppressedError, Symbol */
+var __assign = function() {
+    __assign = Object.assign || function __assign(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
 var SCREEB_TAG_ENDPOINT = "https://t.screeb.app/tag.js";
 var CONSTANTS = { version: "0.0.0-dev" };
 var _window = typeof window === "undefined" ? undefined : window;
@@ -81,6 +114,8 @@ var load = function (options) {
  * @param hooks Hooks to be called when SDK is ready or a survey is showed, started, completed, hidden
  * or when a question is replied.
  *
+ * @param language Force a specific language for the tag. eg: 'en'. default: browser language.
+ *
  * @example
  * ```ts
  * import * as Screeb from "@screeb/sdk-browser";
@@ -99,10 +134,11 @@ var load = function (options) {
  *     version: "1.0.0",
  *     onReady: (payload) =>  console.log("Screeb SDK is ready!", payload),
  *   },
+ *   "en"
  * );
  * ```
  */
-var init = function (websiteId, userId, userProperties, hooks) {
+var init = function (websiteId, userId, userProperties, hooks, language) {
     var identityObject;
     if (userId || userProperties) {
         identityObject = {
@@ -113,6 +149,9 @@ var init = function (websiteId, userId, userProperties, hooks) {
             },
         };
     }
+    if (language) {
+        identityObject = __assign(__assign({}, identityObject), { language: language });
+    }
     return callScreebCommand("init", websiteId, identityObject);
 };
 /**
@@ -382,14 +421,16 @@ var surveyClose = function () { return callScreebCommand("survey.close"); };
  *     version: "1.0.0",
  *     onSurveyShowed: (payload) => console.log("Survey showed", payload),
  *   },
+ *   "en"
  * );
  * ```
  */
-var surveyStart = function (surveyId, allowMultipleResponses, hiddenFields, hooks) {
+var surveyStart = function (surveyId, allowMultipleResponses, hiddenFields, hooks, language) {
     if (allowMultipleResponses === void 0) { allowMultipleResponses = true; }
     if (hiddenFields === void 0) { hiddenFields = {}; }
     return callScreebCommand("survey.start", surveyId, {
         allow_multiple_responses: allowMultipleResponses,
+        language: language,
         hidden_fields: hiddenFields,
         hooks: hooks,
     });
@@ -447,4 +488,4 @@ exports.surveyClose = surveyClose;
 exports.surveyStart = surveyStart;
 exports.targetingCheck = targetingCheck;
 exports.targetingDebug = targetingDebug;
-CONSTANTS.version = '0.1.16'
+CONSTANTS.version = '0.1.17'

package/dist/cjs/index.d.ts CHANGED Viewed

@@ -30,6 +30,8 @@ export declare const load: (options?: ScreebOptions) => Promise<undefined>;
  * @param hooks Hooks to be called when SDK is ready or a survey is showed, started, completed, hidden
  * or when a question is replied.
  *
+ * @param language Force a specific language for the tag. eg: 'en'. default: browser language.
+ *
  * @example
  * ```ts
  * import * as Screeb from "@screeb/sdk-browser";
@@ -48,10 +50,11 @@ export declare const load: (options?: ScreebOptions) => Promise<undefined>;
  *     version: "1.0.0",
  *     onReady: (payload) =>  console.log("Screeb SDK is ready!", payload),
  *   },
+ *   "en"
  * );
  * ```
  */
-export declare const init: (websiteId: string, userId?: string, userProperties?: PropertyRecord, hooks?: Hooks) => void | Promise<unknown>;
+export declare const init: (websiteId: string, userId?: string, userProperties?: PropertyRecord, hooks?: Hooks, language?: string) => void | Promise<unknown>;
 /**
  * Checks if Screeb tag has been loaded.
  *
@@ -307,10 +310,11 @@ export declare const surveyClose: () => void | Promise<unknown>;
  *     version: "1.0.0",
  *     onSurveyShowed: (payload) => console.log("Survey showed", payload),
  *   },
+ *   "en"
  * );
  * ```
  */
-export declare const surveyStart: (surveyId: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: Hooks) => void | Promise<unknown>;
+export declare const surveyStart: (surveyId: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: Hooks, language?: string) => void | Promise<unknown>;
 /**
  * Forces a targeting check.
  *

package/dist/es/index.d.ts CHANGED Viewed

@@ -30,6 +30,8 @@ export declare const load: (options?: ScreebOptions) => Promise<undefined>;
  * @param hooks Hooks to be called when SDK is ready or a survey is showed, started, completed, hidden
  * or when a question is replied.
  *
+ * @param language Force a specific language for the tag. eg: 'en'. default: browser language.
+ *
  * @example
  * ```ts
  * import * as Screeb from "@screeb/sdk-browser";
@@ -48,10 +50,11 @@ export declare const load: (options?: ScreebOptions) => Promise<undefined>;
  *     version: "1.0.0",
  *     onReady: (payload) =>  console.log("Screeb SDK is ready!", payload),
  *   },
+ *   "en"
  * );
  * ```
  */
-export declare const init: (websiteId: string, userId?: string, userProperties?: PropertyRecord, hooks?: Hooks) => void | Promise<unknown>;
+export declare const init: (websiteId: string, userId?: string, userProperties?: PropertyRecord, hooks?: Hooks, language?: string) => void | Promise<unknown>;
 /**
  * Checks if Screeb tag has been loaded.
  *
@@ -307,10 +310,11 @@ export declare const surveyClose: () => void | Promise<unknown>;
  *     version: "1.0.0",
  *     onSurveyShowed: (payload) => console.log("Survey showed", payload),
  *   },
+ *   "en"
  * );
  * ```
  */
-export declare const surveyStart: (surveyId: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: Hooks) => void | Promise<unknown>;
+export declare const surveyStart: (surveyId: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: Hooks, language?: string) => void | Promise<unknown>;
 /**
  * Forces a targeting check.
  *

package/dist/es/index.mjs CHANGED Viewed

@@ -1,3 +1,36 @@
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+/* global Reflect, Promise, SuppressedError, Symbol */
+var __assign = function() {
+    __assign = Object.assign || function __assign(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
 var SCREEB_TAG_ENDPOINT = "https://t.screeb.app/tag.js";
 var CONSTANTS = { version: "0.0.0-dev" };
 var _window = typeof window === "undefined" ? undefined : window;
@@ -79,6 +112,8 @@ var load = function (options) {
  * @param hooks Hooks to be called when SDK is ready or a survey is showed, started, completed, hidden
  * or when a question is replied.
  *
+ * @param language Force a specific language for the tag. eg: 'en'. default: browser language.
+ *
  * @example
  * ```ts
  * import * as Screeb from "@screeb/sdk-browser";
@@ -97,10 +132,11 @@ var load = function (options) {
  *     version: "1.0.0",
  *     onReady: (payload) =>  console.log("Screeb SDK is ready!", payload),
  *   },
+ *   "en"
  * );
  * ```
  */
-var init = function (websiteId, userId, userProperties, hooks) {
+var init = function (websiteId, userId, userProperties, hooks, language) {
     var identityObject;
     if (userId || userProperties) {
         identityObject = {
@@ -111,6 +147,9 @@ var init = function (websiteId, userId, userProperties, hooks) {
             },
         };
     }
+    if (language) {
+        identityObject = __assign(__assign({}, identityObject), { language: language });
+    }
     return callScreebCommand("init", websiteId, identityObject);
 };
 /**
@@ -380,14 +419,16 @@ var surveyClose = function () { return callScreebCommand("survey.close"); };
  *     version: "1.0.0",
  *     onSurveyShowed: (payload) => console.log("Survey showed", payload),
  *   },
+ *   "en"
  * );
  * ```
  */
-var surveyStart = function (surveyId, allowMultipleResponses, hiddenFields, hooks) {
+var surveyStart = function (surveyId, allowMultipleResponses, hiddenFields, hooks, language) {
     if (allowMultipleResponses === void 0) { allowMultipleResponses = true; }
     if (hiddenFields === void 0) { hiddenFields = {}; }
     return callScreebCommand("survey.start", surveyId, {
         allow_multiple_responses: allowMultipleResponses,
+        language: language,
         hidden_fields: hiddenFields,
         hooks: hooks,
     });
@@ -430,4 +471,4 @@ var targetingCheck = function () { return callScreebCommand("targeting.check");
 var targetingDebug = function () { return callScreebCommand("targeting.debug"); };
 export { close, debug, eventTrack, identity, identityGet, identityGroupAssign, identityGroupUnassign, identityProperties, identityReset, init, isLoaded, load, surveyClose, surveyStart, targetingCheck, targetingDebug };
-CONSTANTS.version = '0.1.16'
+CONSTANTS.version = '0.1.17'

package/docs/README.md CHANGED Viewed

@@ -88,7 +88,7 @@ ___
 ### 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`
+Ƭ **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
@@ -98,7 +98,7 @@ ___
 | 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``  }  } |
+| `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
@@ -108,7 +108,7 @@ ___
 ### HookOnReady
-Ƭ **HookOnReady**: (`data`: { `channel`: [`Channel`](README.md#channel) ; `user`: [`User`](README.md#user)  }) => `void`
+Ƭ **HookOnReady**: (`data`: \{ `channel`: [`Channel`](README.md#channel) ; `user`: [`User`](README.md#user)  }) => `void`
 #### Type declaration
@@ -130,7 +130,7 @@ ___
 ### HookOnSurveyCompleted
-Ƭ **HookOnSurveyCompleted**: (`data`: [`HookCommonProperties`](README.md#hookcommonproperties) & { `response`: { `id`: `string` ; `items`: [`ResponseItem`](README.md#responseitem)[]  }  }) => `void`
+Ƭ **HookOnSurveyCompleted**: (`data`: [`HookCommonProperties`](README.md#hookcommonproperties) & \{ `response`: \{ `id`: `string` ; `items`: [`ResponseItem`](README.md#responseitem)[]  }  }) => `void`
 #### Type declaration
@@ -140,7 +140,7 @@ ___
 | Name | Type |
 | :------ | :------ |
-| `data` | [`HookCommonProperties`](README.md#hookcommonproperties) & { `response`: { `id`: `string` ; `items`: [`ResponseItem`](README.md#responseitem)[]  }  } |
+| `data` | [`HookCommonProperties`](README.md#hookcommonproperties) & \{ `response`: \{ `id`: `string` ; `items`: [`ResponseItem`](README.md#responseitem)[]  }  } |
 ##### Returns
@@ -150,7 +150,7 @@ ___
 ### HookOnSurveyHidden
-Ƭ **HookOnSurveyHidden**: (`data`: [`HookCommonProperties`](README.md#hookcommonproperties) & { `response`: { `hide_reason`: [`ResponseStatus`](README.md#responsestatus) ; `id`: `string` ; `items`: [`ResponseItem`](README.md#responseitem)[]  }  }) => `void`
+Ƭ **HookOnSurveyHidden**: (`data`: [`HookCommonProperties`](README.md#hookcommonproperties) & \{ `response`: \{ `hide_reason`: [`ResponseStatus`](README.md#responsestatus) ; `id`: `string` ; `items`: [`ResponseItem`](README.md#responseitem)[]  }  }) => `void`
 #### Type declaration
@@ -160,7 +160,7 @@ ___
 | Name | Type |
 | :------ | :------ |
-| `data` | [`HookCommonProperties`](README.md#hookcommonproperties) & { `response`: { `hide_reason`: [`ResponseStatus`](README.md#responsestatus) ; `id`: `string` ; `items`: [`ResponseItem`](README.md#responseitem)[]  }  } |
+| `data` | [`HookCommonProperties`](README.md#hookcommonproperties) & \{ `response`: \{ `hide_reason`: [`ResponseStatus`](README.md#responsestatus) ; `id`: `string` ; `items`: [`ResponseItem`](README.md#responseitem)[]  }  } |
 ##### Returns
@@ -170,7 +170,7 @@ ___
 ### HookOnSurveyShowed
-Ƭ **HookOnSurveyShowed**: (`data`: [`HookCommonProperties`](README.md#hookcommonproperties) & { `response`: { `id`: `string` ; `items`: [`ResponseItem`](README.md#responseitem)[]  }  }) => `void`
+Ƭ **HookOnSurveyShowed**: (`data`: [`HookCommonProperties`](README.md#hookcommonproperties) & \{ `response`: \{ `id`: `string` ; `items`: [`ResponseItem`](README.md#responseitem)[]  }  }) => `void`
 #### Type declaration
@@ -180,7 +180,7 @@ ___
 | Name | Type |
 | :------ | :------ |
-| `data` | [`HookCommonProperties`](README.md#hookcommonproperties) & { `response`: { `id`: `string` ; `items`: [`ResponseItem`](README.md#responseitem)[]  }  } |
+| `data` | [`HookCommonProperties`](README.md#hookcommonproperties) & \{ `response`: \{ `id`: `string` ; `items`: [`ResponseItem`](README.md#responseitem)[]  }  } |
 ##### Returns
@@ -190,7 +190,7 @@ ___
 ### HookOnSurveyStarted
-Ƭ **HookOnSurveyStarted**: (`data`: [`HookCommonProperties`](README.md#hookcommonproperties) & { `response`: { `id`: `string`  }  }) => `void`
+Ƭ **HookOnSurveyStarted**: (`data`: [`HookCommonProperties`](README.md#hookcommonproperties) & \{ `response`: \{ `id`: `string`  }  }) => `void`
 #### Type declaration
@@ -200,7 +200,7 @@ ___
 | Name | Type |
 | :------ | :------ |
-| `data` | [`HookCommonProperties`](README.md#hookcommonproperties) & { `response`: { `id`: `string`  }  } |
+| `data` | [`HookCommonProperties`](README.md#hookcommonproperties) & \{ `response`: \{ `id`: `string`  }  } |
 ##### Returns
@@ -269,7 +269,7 @@ ___
 | Name | Type |
 | :------ | :------ |
-| `fields?` | { `boolean?`: `boolean` ; `number?`: `number` ; `text?`: `string` ; `time?`: `string` ; `type`: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"none"`` \| ``"time"`` \| ``"file"``  }[] |
+| `fields?` | \{ `boolean?`: `boolean` ; `number?`: `number` ; `text?`: `string` ; `time?`: `string` ; `type`: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"none"`` \| ``"time"`` \| ``"file"``  }[] |
 | `replied_at?` | `string` |
 ___
@@ -297,11 +297,11 @@ ___
 ### ScreebFunction
-Ƭ **ScreebFunction**: (...`_`: `unknown`[]) => `void` \| `Promise`<`unknown`\>
+Ƭ **ScreebFunction**: (...`_`: `unknown`[]) => `void` \| `Promise`\<`unknown`\>
 #### Type declaration
-▸ (`..._`): `void` \| `Promise`<`unknown`\>
+▸ (`..._`): `void` \| `Promise`\<`unknown`\>
 ##### Parameters
@@ -311,7 +311,7 @@ ___
 ##### Returns
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 ___
@@ -337,7 +337,7 @@ ___
 ### ScreebObject
-Ƭ **ScreebObject**: [`ScreebFunction`](README.md#screebfunction) & { `q?`: { `args`: `unknown`[] ; `ko`: (`reason?`: `unknown`) => `void` ; `ok`: (`value?`: `unknown`) => `void` ; `v`: `number`  }[]  }
+Ƭ **ScreebObject**: [`ScreebFunction`](README.md#screebfunction) & \{ `q?`: \{ `args`: `unknown`[] ; `ko`: (`reason?`: `unknown`) => `void` ; `ok`: (`value?`: `unknown`) => `void` ; `v`: `number`  }[]  }
 This is the Screeb object publicly exposed in browser `window`.
@@ -408,13 +408,13 @@ ___
 ### close
-▸ **close**(): `void` \| `Promise`<`unknown`\>
+▸ **close**(): `void` \| `Promise`\<`unknown`\>
 Shutdowns current Screeb session.
 #### Returns
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 **`Example`**
@@ -428,13 +428,13 @@ ___
 ### debug
-▸ **debug**(): `void` \| `Promise`<`unknown`\>
+▸ **debug**(): `void` \| `Promise`\<`unknown`\>
 Prints the actual state information of Screeb tag.
 #### Returns
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 **`Example`**
@@ -465,7 +465,7 @@ ___
 ### eventTrack
-▸ **eventTrack**(`eventName`, `eventProperties?`): `void` \| `Promise`<`unknown`\>
+▸ **eventTrack**(`eventName`, `eventProperties?`): `void` \| `Promise`\<`unknown`\>
 Tracks a user event.
@@ -478,7 +478,7 @@ Tracks a user event.
 #### Returns
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 **`Example`**
@@ -505,7 +505,7 @@ ___
 ### identity
-▸ **identity**(`userId`, `userProperties?`): `void` \| `Promise`<`unknown`\>
+▸ **identity**(`userId`, `userProperties?`): `void` \| `Promise`\<`unknown`\>
 Change the current user identity.
 Warning: Running surveys will be closed.
@@ -519,7 +519,7 @@ Warning: Running surveys will be closed.
 #### Returns
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 **`Example`**
@@ -542,13 +542,13 @@ ___
 ### identityGet
-▸ **identityGet**(): `Promise`<[`ScreebIdentityGetReturn`](README.md#screebidentitygetreturn)\>
+▸ **identityGet**(): `Promise`\<[`ScreebIdentityGetReturn`](README.md#screebidentitygetreturn)\>
 Retrieves the current user identity.
 #### Returns
-`Promise`<[`ScreebIdentityGetReturn`](README.md#screebidentitygetreturn)\>
+`Promise`\<[`ScreebIdentityGetReturn`](README.md#screebidentitygetreturn)\>
 **`Example`**
@@ -571,7 +571,7 @@ ___
 ### identityGroupAssign
-▸ **identityGroupAssign**(`groupName`, `groupType?`, `groupProperties?`): `void` \| `Promise`<`unknown`\>
+▸ **identityGroupAssign**(`groupName`, `groupType?`, `groupProperties?`): `void` \| `Promise`\<`unknown`\>
 Assigns the current user to a group.
@@ -585,7 +585,7 @@ Assigns the current user to a group.
 #### Returns
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 **`Example`**
@@ -610,7 +610,7 @@ ___
 ### identityGroupUnassign
-▸ **identityGroupUnassign**(`groupName`, `groupType?`): `void` \| `Promise`<`unknown`\>
+▸ **identityGroupUnassign**(`groupName`, `groupType?`): `void` \| `Promise`\<`unknown`\>
 Unassigns the current user to a group.
@@ -623,7 +623,7 @@ Unassigns the current user to a group.
 #### Returns
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 **`Example`**
@@ -637,7 +637,7 @@ ___
 ### identityProperties
-▸ **identityProperties**(`userProperties`): `void` \| `Promise`<`unknown`\>
+▸ **identityProperties**(`userProperties`): `void` \| `Promise`\<`unknown`\>
 Adds properties to the current user identity.
@@ -649,7 +649,7 @@ Adds properties to the current user identity.
 #### Returns
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 **`Example`**
@@ -681,14 +681,14 @@ ___
 ### identityReset
-▸ **identityReset**(): `void` \| `Promise`<`unknown`\>
+▸ **identityReset**(): `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.
 #### Returns
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 **`Example`**
@@ -702,7 +702,7 @@ ___
 ### init
-▸ **init**(`websiteId`, `userId?`, `userProperties?`, `hooks?`): `void` \| `Promise`<`unknown`\>
+▸ **init**(`websiteId`, `userId?`, `userProperties?`, `hooks?`, `language?`): `void` \| `Promise`\<`unknown`\>
 Initializes Screeb tag.
@@ -714,10 +714,11 @@ Initializes Screeb tag.
 | `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 ``` |
 | `hooks?` | [`Hooks`](README.md#hooks) | Hooks to be called when SDK is ready or a survey is showed, started, completed, hidden or when a question is replied. |
+| `language?` | `string` | Force a specific language for the tag. eg: 'en'. default: browser language. |
 #### Returns
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 **`Example`**
@@ -738,6 +739,7 @@ Screeb.init(
     version: "1.0.0",
     onReady: (payload) =>  console.log("Screeb SDK is ready!", payload),
   },
+  "en"
 );
 ```
@@ -767,7 +769,7 @@ ___
 ### load
-▸ **load**(`options?`): `Promise`<`undefined`\>
+▸ **load**(`options?`): `Promise`\<`undefined`\>
 Appends Screeb tag into your dom.
@@ -779,7 +781,7 @@ Appends Screeb tag into your dom.
 #### Returns
-`Promise`<`undefined`\>
+`Promise`\<`undefined`\>
 **`Example`**
@@ -793,13 +795,13 @@ ___
 ### surveyClose
-▸ **surveyClose**(): `void` \| `Promise`<`unknown`\>
+▸ **surveyClose**(): `void` \| `Promise`\<`unknown`\>
 Interrupts a running survey.
 #### Returns
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 **`Example`**
@@ -813,7 +815,7 @@ ___
 ### surveyStart
-▸ **surveyStart**(`surveyId`, `allowMultipleResponses?`, `hiddenFields?`, `hooks?`): `void` \| `Promise`<`unknown`\>
+▸ **surveyStart**(`surveyId`, `allowMultipleResponses?`, `hiddenFields?`, `hooks?`, `language?`): `void` \| `Promise`\<`unknown`\>
 Starts a survey by its ID.
@@ -825,10 +827,11 @@ Starts a survey by its ID.
 | `allowMultipleResponses` | `boolean` | `true` |
 | `hiddenFields` | [`PropertyRecord`](README.md#propertyrecord) | `{}` |
 | `hooks?` | [`Hooks`](README.md#hooks) | `undefined` |
+| `language?` | `string` | `undefined` |
 #### Returns
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 **`Example`**
@@ -846,6 +849,7 @@ Screeb.surveyStart(
     version: "1.0.0",
     onSurveyShowed: (payload) => console.log("Survey showed", payload),
   },
+  "en"
 );
 ```
@@ -853,13 +857,13 @@ ___
 ### targetingCheck
-▸ **targetingCheck**(): `void` \| `Promise`<`unknown`\>
+▸ **targetingCheck**(): `void` \| `Promise`\<`unknown`\>
 Forces a targeting check.
 #### Returns
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 **`Example`**
@@ -873,13 +877,13 @@ ___
 ### targetingDebug
-▸ **targetingDebug**(): `void` \| `Promise`<`unknown`\>
+▸ **targetingDebug**(): `void` \| `Promise`\<`unknown`\>
 Prints the current state of the targeting engine.
 #### Returns
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 **`Example`**

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@screeb/sdk-browser",
-  "version": "0.1.16",
+  "version": "0.1.17",
   "description": "Screeb's browser sdk.",
   "keywords": [
     "product discovery",

package/readme/screeb-logo.svg ADDED Viewed

@@ -0,0 +1,15 @@
+<svg width="773" height="366" viewBox="0 0 773 366" fill="none" xmlns="http://www.w3.org/2000/svg">
+    <g clip-path="url(#clip0_201_47)">
+        <path fill-rule="evenodd" clip-rule="evenodd"
+            d="M711.7 197.1C714.6 194.1 717.2 191.1 719.7 187.9C750.7 201 772.5 230.9 772.4 266.5V364.7L684.5 365.3H606.7C558.6 365.3 520.5 325.3 520.5 277.1C520.5 261.5 524.5 245.9 531.5 232H630.4C661.2 232 690.1 219.5 711.7 197.1ZM600.2 292.8C609.1 292.8 616.1 285.6 616.1 276.9C616.1 268.4 609 261.2 600.2 261.2C591.5 261.2 584.5 268.4 584.5 276.9C584.5 285.6 591.5 292.8 600.2 292.8ZM645.5 292.8C654.4 292.8 661.4 285.6 661.4 276.9C661.4 268.4 654.4 261.2 645.5 261.2C636.8 261.2 629.8 268.4 629.8 276.9C629.8 285.6 636.8 292.8 645.5 292.8ZM690.9 292.8C699.8 292.8 706.8 285.6 706.8 276.9C706.8 268.4 699.7 261.2 690.9 261.2C682.2 261.2 675.2 268.4 675.2 276.9C675.2 285.6 682.2 292.8 690.9 292.8Z"
+            fill="#5e21f1" />
+        <path fill-rule="evenodd" clip-rule="evenodd"
+            d="M626.5 213C682 213 725.9 166.6 725.9 111.1C725.9 55.6 682 0 626.4 0H102.7C47.2 0 0 42.7 0 98.3V211.8L102.7 213H626.5ZM98.8 147.6C98.8 151.7 100.9 155.4 103.8 157.5C117.2 167.1 133.1 171.9 148.6 171.7C174.4 171.7 192.5 158.4 192.5 134.6V134.3C192.5 113.4 178.9 104.7 154.6 98.4C133.9 93.1 128.8 90.6 128.8 82.7V82.4C128.8 76.6 134.1 72 144.2 72C152.4 72 160.6 74.9 169.3 80C171.4 81.2 173.4 81.9 176 81.9C182.8 81.9 188.3 76.6 188.3 69.8C188.3 64.7 185.4 61.1 182.5 59.4C171.8 52.6 159.1 48.8 144.6 48.8C120.1 48.8 102.7 63.2 102.7 84.9V85.2C102.7 109 118.3 115.6 142.4 121.8C162.4 126.9 166.5 130.3 166.5 137V137.4C166.5 144.4 160 148.7 149.2 148.7C137.6 148.7 127.7 144.6 118.6 137.9C116.9 136.7 114.5 135.5 111.1 135.5C104.3 135.5 98.8 140.8 98.8 147.6ZM200.8 124.9V124.6C200.8 98.4 220.8 76.9 248.8 76.9C262.6 76.9 272.4 80.7 280.1 87.2C281.8 88.6 284.2 91.6 284.2 96.1C284.2 102.6 278.9 107.7 272.4 107.7C269 107.7 266.4 106.3 264.9 105.1C260.3 101.5 255.5 99.3 248.7 99.3C235.7 99.3 226.5 110.8 226.5 124.3V124.6C226.5 138.6 235.6 149.9 249.7 149.9C256.5 149.9 261.8 147.5 266.8 143.6C268.2 142.6 270.7 141.2 273.8 141.2C280 141.2 284.7 146.2 284.7 152.3C284.7 155.7 283.2 158.5 280.9 160.5C273.2 167.5 263.5 172.3 248.4 172.3C220.9 172.2 200.8 151.1 200.8 124.9ZM308.1 77.5C300.9 77.5 295.1 83.3 295.1 90.5V158.1C295.1 165.3 300.9 171.1 308.1 171.1C315.3 171.1 321.1 165.3 321.1 158.1V133.8C321.1 115.4 328.4 105.3 341.6 102.2C346.9 101 351.3 96.9 351.3 90.1C351.3 82.8 346.7 77.5 338.7 77.5C331 77.5 324.9 85.7 321.1 94.6V90.5C321.1 83.3 315.3 77.5 308.1 77.5ZM521.3 121C521.3 102 507.8 76.9 477.2 76.9C458.9 76.9 444.3 87.1 437 101.9C430.9 88.5 418 76.9 397.2 76.9C370.5 76.9 351.9 98.4 351.9 124.6V124.9C351.9 152.9 372.2 172.3 399.8 172.3C413.1 172.3 423.6 168 431.6 161.2C433.5 159.5 435 156.9 435 153.5C435 147.7 430.7 143.2 424.9 143.2C422.2 143.2 420.5 143.9 418.6 145.3C413.3 149.2 407.3 151.5 400.1 151.5C388.5 151.5 380.3 145.3 377.7 133.6H432.561C436.215 156.976 455.14 172.4 479.8 172.4C493.1 172.4 503.6 168.1 511.6 161.3C513.5 159.6 515 157 515 153.6C515 147.8 510.7 143.3 504.9 143.3C502.2 143.3 500.5 144 498.6 145.4C493.3 149.3 487.3 151.6 480.1 151.6C468.5 151.6 460.3 145.4 457.7 133.7H509.2C516 133.4 521.3 128.5 521.3 121ZM432.5 133.2L432.522 133.349C432.308 133.302 432.246 133.251 432.5 133.2ZM377.4 117.2C379.5 105.4 386.5 97.7 397.2 97.7C408.1 97.7 415 105.6 416.5 117.2H377.4ZM457.4 117.2C459.5 105.4 466.5 97.7 477.2 97.7C488.1 97.7 495 105.6 496.5 117.2H457.4ZM546.4 44.4C539.2 44.4 533.4 50.2 533.4 57.4V158.3C533.4 165.5 539.2 171.3 546.4 171.3C553.6 171.3 559.4 165.5 559.4 158.5V158.3C565.5 165.7 574.1 172 587.9 172C609.6 172 629.6 155.2 629.6 124.6V124.3C629.6 93.7 609.3 76.9 587.9 76.9C574.4 76.9 565.7 83.3 559.4 91.8V57.4C559.4 50.2 553.6 44.4 546.4 44.4ZM603.7 124.3V124.6C603.7 139.9 593.4 149.9 581.3 149.9C569.2 149.9 559.1 139.8 559.1 124.6V124.3C559.1 109.1 569.2 99 581.3 99C593.4 99 603.7 109.1 603.7 124.3Z"
+            fill="#5e21f1" />
+    </g>
+    <defs>
+        <clipPath id="clip0_201_47">
+            <rect width="772.5" height="365.4" fill="#5e21f1" />
+        </clipPath>
+    </defs>
+</svg>