@screeb/sdk-browser 0.1.16 → 0.1.18

package/dist/cjs/index.cjs

@@ -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,57 @@ 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,
+    });
+};
+/**
+ * Interrupts a running message.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.messageClose();
+ * ```
+ */
+var messageClose = function () { return callScreebCommand("message.close"); };
+/**
+ * Starts a message by its ID.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.messageStart(
+ *   '<UUID>',
+ *   false,
+ *   {
+ *     color: "green",
+ *     article_id: 42
+ *   },
+ *   {
+ *     version: "1.0.0",
+ *     onMessageShowed: (payload) => console.log("Message showed", payload),
+ *   },
+ *   "en"
+ * );
+ * ```
+ */
+var messageStart = function (messageId, hiddenFields, hooks, language) {
+    if (hiddenFields === void 0) { hiddenFields = {}; }
+    return callScreebCommand("message.start", messageId, {
+        language: language,
         hidden_fields: hiddenFields,
         hooks: hooks,
     });
@@ -443,8 +525,10 @@ exports.identityReset = identityReset;
 exports.init = init;
 exports.isLoaded = isLoaded;
 exports.load = load;
+exports.messageClose = messageClose;
+exports.messageStart = messageStart;
 exports.surveyClose = surveyClose;
 exports.surveyStart = surveyStart;
 exports.targetingCheck = targetingCheck;
 exports.targetingDebug = targetingDebug;
-CONSTANTS.version = '0.1.16'
+CONSTANTS.version = '0.1.18'

package/dist/cjs/index.d.ts

@@ -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,45 @@ 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, language?: string) => void | Promise<unknown>;
+/**
+ * Interrupts a running message.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.messageClose();
+ * ```
+ */
+export declare const messageClose: () => void | Promise<unknown>;
+/**
+ * Starts a message by its ID.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.messageStart(
+ *   '<UUID>',
+ *   false,
+ *   {
+ *     color: "green",
+ *     article_id: 42
+ *   },
+ *   {
+ *     version: "1.0.0",
+ *     onMessageShowed: (payload) => console.log("Message showed", payload),
+ *   },
+ *   "en"
  * );
  * ```
  */
-export declare const surveyStart: (surveyId: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: Hooks) => void | Promise<unknown>;
+export declare const messageStart: (messageId: string, hiddenFields?: PropertyRecord, hooks?: Hooks, language?: string) => void | Promise<unknown>;
 /**
  * Forces a targeting check.
  *

package/dist/es/index.d.ts

@@ -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,45 @@ 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, language?: string) => void | Promise<unknown>;
+/**
+ * Interrupts a running message.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.messageClose();
+ * ```
+ */
+export declare const messageClose: () => void | Promise<unknown>;
+/**
+ * Starts a message by its ID.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.messageStart(
+ *   '<UUID>',
+ *   false,
+ *   {
+ *     color: "green",
+ *     article_id: 42
+ *   },
+ *   {
+ *     version: "1.0.0",
+ *     onMessageShowed: (payload) => console.log("Message showed", payload),
+ *   },
+ *   "en"
  * );
  * ```
  */
-export declare const surveyStart: (surveyId: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: Hooks) => void | Promise<unknown>;
+export declare const messageStart: (messageId: string, hiddenFields?: PropertyRecord, hooks?: Hooks, language?: string) => void | Promise<unknown>;
 /**
  * Forces a targeting check.
  *

package/dist/es/index.mjs

@@ -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,57 @@ 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,
+    });
+};
+/**
+ * Interrupts a running message.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.messageClose();
+ * ```
+ */
+var messageClose = function () { return callScreebCommand("message.close"); };
+/**
+ * Starts a message by its ID.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.messageStart(
+ *   '<UUID>',
+ *   false,
+ *   {
+ *     color: "green",
+ *     article_id: 42
+ *   },
+ *   {
+ *     version: "1.0.0",
+ *     onMessageShowed: (payload) => console.log("Message showed", payload),
+ *   },
+ *   "en"
+ * );
+ * ```
+ */
+var messageStart = function (messageId, hiddenFields, hooks, language) {
+    if (hiddenFields === void 0) { hiddenFields = {}; }
+    return callScreebCommand("message.start", messageId, {
+        language: language,
         hidden_fields: hiddenFields,
         hooks: hooks,
     });
@@ -429,5 +511,5 @@ 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'
+export { close, debug, eventTrack, identity, identityGet, identityGroupAssign, identityGroupUnassign, identityProperties, identityReset, init, isLoaded, load, messageClose, messageStart, surveyClose, surveyStart, targetingCheck, targetingDebug };
+CONSTANTS.version = '0.1.18'

package/docs/README.md

@@ -46,6 +46,8 @@
 - [init](README.md#init)
 - [isLoaded](README.md#isloaded)
 - [load](README.md#load)
+- [messageClose](README.md#messageclose)
+- [messageStart](README.md#messagestart)
 - [surveyClose](README.md#surveyclose)
 - [surveyStart](README.md#surveystart)
 - [targetingCheck](README.md#targetingcheck)
@@ -88,7 +90,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 +100,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 +110,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 +132,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 +142,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 +152,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 +162,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 +172,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 +182,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 +192,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 +202,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `data` | [`HookCommonProperties`](README.md#hookcommonproperties) & { `response`: { `id`: `string`  }  } |
+| `data` | [`HookCommonProperties`](README.md#hookcommonproperties) & \{ `response`: \{ `id`: `string`  }  } |
 
 ##### Returns
 
@@ -269,7 +271,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 +299,11 @@ ___
 
 ### ScreebFunction
 
-Ƭ **ScreebFunction**: (...`_`: `unknown`[]) => `void` \| `Promise`<`unknown`\>
+Ƭ **ScreebFunction**: (...`_`: `unknown`[]) => `void` \| `Promise`\<`unknown`\>
 
 #### Type declaration
 
-▸ (`..._`): `void` \| `Promise`<`unknown`\>
+▸ (`..._`): `void` \| `Promise`\<`unknown`\>
 
 ##### Parameters
 
@@ -311,7 +313,7 @@ ___
 
 ##### Returns
 
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 
 ___
 
@@ -337,7 +339,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 +410,13 @@ ___
 
 ### close
 
-▸ **close**(): `void` \| `Promise`<`unknown`\>
+▸ **close**(): `void` \| `Promise`\<`unknown`\>
 
 Shutdowns current Screeb session.
 
 #### Returns
 
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 
 **`Example`**
 
@@ -428,13 +430,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 +467,7 @@ ___
 
 ### eventTrack
 
-▸ **eventTrack**(`eventName`, `eventProperties?`): `void` \| `Promise`<`unknown`\>
+▸ **eventTrack**(`eventName`, `eventProperties?`): `void` \| `Promise`\<`unknown`\>
 
 Tracks a user event.
 
@@ -478,7 +480,7 @@ Tracks a user event.
 
 #### Returns
 
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 
 **`Example`**
 
@@ -505,7 +507,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 +521,7 @@ Warning: Running surveys will be closed.
 
 #### Returns
 
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 
 **`Example`**
 
@@ -542,13 +544,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 +573,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 +587,7 @@ Assigns the current user to a group.
 
 #### Returns
 
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 
 **`Example`**
 
@@ -610,7 +612,7 @@ ___
 
 ### identityGroupUnassign
 
-▸ **identityGroupUnassign**(`groupName`, `groupType?`): `void` \| `Promise`<`unknown`\>
+▸ **identityGroupUnassign**(`groupName`, `groupType?`): `void` \| `Promise`\<`unknown`\>
 
 Unassigns the current user to a group.
 
@@ -623,7 +625,7 @@ Unassigns the current user to a group.
 
 #### Returns
 
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 
 **`Example`**
 
@@ -637,7 +639,7 @@ ___
 
 ### identityProperties
 
-▸ **identityProperties**(`userProperties`): `void` \| `Promise`<`unknown`\>
+▸ **identityProperties**(`userProperties`): `void` \| `Promise`\<`unknown`\>
 
 Adds properties to the current user identity.
 
@@ -649,7 +651,7 @@ Adds properties to the current user identity.
 
 #### Returns
 
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 
 **`Example`**
 
@@ -681,14 +683,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 +704,7 @@ ___
 
 ### init
 
-▸ **init**(`websiteId`, `userId?`, `userProperties?`, `hooks?`): `void` \| `Promise`<`unknown`\>
+▸ **init**(`websiteId`, `userId?`, `userProperties?`, `hooks?`, `language?`): `void` \| `Promise`\<`unknown`\>
 
 Initializes Screeb tag.
 
@@ -714,10 +716,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 +741,7 @@ Screeb.init(
     version: "1.0.0",
     onReady: (payload) =>  console.log("Screeb SDK is ready!", payload),
   },
+  "en"
 );
 ```
 
@@ -767,7 +771,7 @@ ___
 
 ### load
 
-▸ **load**(`options?`): `Promise`<`undefined`\>
+▸ **load**(`options?`): `Promise`\<`undefined`\>
 
 Appends Screeb tag into your dom.
 
@@ -779,7 +783,7 @@ Appends Screeb tag into your dom.
 
 #### Returns
 
-`Promise`<`undefined`\>
+`Promise`\<`undefined`\>
 
 **`Example`**
 
@@ -791,15 +795,76 @@ Screeb.load();
 
 ___
 
+### messageClose
+
+▸ **messageClose**(): `void` \| `Promise`\<`unknown`\>
+
+Interrupts a running message.
+
+#### Returns
+
+`void` \| `Promise`\<`unknown`\>
+
+**`Example`**
+
+```ts
+import * as Screeb from "@screeb/sdk-browser";
+
+Screeb.messageClose();
+```
+
+___
+
+### messageStart
+
+▸ **messageStart**(`messageId`, `hiddenFields?`, `hooks?`, `language?`): `void` \| `Promise`\<`unknown`\>
+
+Starts a message by its ID.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messageId` | `string` |
+| `hiddenFields` | [`PropertyRecord`](README.md#propertyrecord) |
+| `hooks?` | [`Hooks`](README.md#hooks) |
+| `language?` | `string` |
+
+#### Returns
+
+`void` \| `Promise`\<`unknown`\>
+
+**`Example`**
+
+```ts
+import * as Screeb from "@screeb/sdk-browser";
+
+Screeb.messageStart(
+  '<UUID>',
+  false,
+  {
+    color: "green",
+    article_id: 42
+  },
+  {
+    version: "1.0.0",
+    onMessageShowed: (payload) => console.log("Message showed", payload),
+  },
+  "en"
+);
+```
+
+___
+
 ### surveyClose
 
-▸ **surveyClose**(): `void` \| `Promise`<`unknown`\>
+▸ **surveyClose**(): `void` \| `Promise`\<`unknown`\>
 
 Interrupts a running survey.
 
 #### Returns
 
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 
 **`Example`**
 
@@ -813,7 +878,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 +890,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 +912,7 @@ Screeb.surveyStart(
     version: "1.0.0",
     onSurveyShowed: (payload) => console.log("Survey showed", payload),
   },
+  "en"
 );
 ```
 
@@ -853,13 +920,13 @@ ___
 
 ### targetingCheck
 
-▸ **targetingCheck**(): `void` \| `Promise`<`unknown`\>
+▸ **targetingCheck**(): `void` \| `Promise`\<`unknown`\>
 
 Forces a targeting check.
 
 #### Returns
 
-`void` \| `Promise`<`unknown`\>
+`void` \| `Promise`\<`unknown`\>
 
 **`Example`**
 
@@ -873,13 +940,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

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