@screeb/sdk-react 0.1.10 → 0.1.11

package/dist/cjs/index.cjs

@@ -141,7 +141,7 @@ var isSSR = typeof window === "undefined";
 var CONSTANTS = { version: "0.0.0-dev" };
 var isInitialized = false;
 var ScreebProvider = function (_a) {
-    var websiteId = _a.websiteId, userId = _a.userId, userProperties = _a.userProperties, hooks = _a.hooks, children = _a.children, _b = _a.shouldLoad, shouldLoad = _b === void 0 ? !isSSR : _b, _c = _a.autoInit, autoInit = _c === void 0 ? false : _c, options = _a.options, rest = __rest(_a, ["websiteId", "userId", "userProperties", "hooks", "children", "shouldLoad", "autoInit", "options"]);
+    var websiteId = _a.websiteId, userId = _a.userId, userProperties = _a.userProperties, hooks = _a.hooks, language = _a.language, children = _a.children, _b = _a.shouldLoad, shouldLoad = _b === void 0 ? !isSSR : _b, _c = _a.autoInit, autoInit = _c === void 0 ? false : _c, options = _a.options, rest = __rest(_a, ["websiteId", "userId", "userProperties", "hooks", "language", "children", "shouldLoad", "autoInit", "options"]);
     var isLoaded = React__namespace.useRef(Screeb__namespace.isLoaded());
     // Allow data-x attributes, see https://github.com/devrnt/react-use-screeb/issues/478
     var invalidPropKeys = Object.keys(rest).filter(function (key) { return !key.startsWith("data-"); });
@@ -258,12 +258,12 @@ var ScreebProvider = function (_a) {
             case 1: return [2 /*return*/, _a.sent()];
         }
     }); }); }, []);
-    var init = React__namespace.useCallback(function (websiteId, userId, userProperties, hooks) { return __awaiter(void 0, void 0, void 0, function () {
+    var init = React__namespace.useCallback(function (websiteId, userId, userProperties, hooks, language) { return __awaiter(void 0, void 0, void 0, function () {
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, ensureScreeb("init", function () {
                         if (!isInitialized) {
-                            Screeb__namespace.init(websiteId, userId, userProperties, hooks);
+                            Screeb__namespace.init(websiteId, userId, userProperties, hooks, language);
                             isInitialized = true;
                         }
                     }, true)];
@@ -282,7 +282,7 @@ var ScreebProvider = function (_a) {
                     isLoaded.current = true;
                     if (!autoInit) return [3 /*break*/, 3];
                     if (!websiteId) return [3 /*break*/, 2];
-                    return [4 /*yield*/, init(websiteId, userId, userProperties, hooks)];
+                    return [4 /*yield*/, init(websiteId, userId, userProperties, hooks, language)];
                 case 1:
                     _a.sent();
                     return [3 /*break*/, 3];
@@ -299,11 +299,11 @@ var ScreebProvider = function (_a) {
             case 1: return [2 /*return*/, _a.sent()];
         }
     }); }); }, []);
-    var surveyStart = React__namespace.useCallback(function (surveyId, allowMultipleResponses, hiddenFields, hooks) { return __awaiter(void 0, void 0, void 0, function () {
+    var surveyStart = React__namespace.useCallback(function (surveyId, allowMultipleResponses, hiddenFields, hooks, language) { return __awaiter(void 0, void 0, void 0, function () {
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, ensureScreeb("surveyStart", function () {
-                        return Screeb__namespace.surveyStart(surveyId, allowMultipleResponses, hiddenFields, hooks);
+                        return Screeb__namespace.surveyStart(surveyId, allowMultipleResponses, hiddenFields, hooks, language);
                     })];
                 case 1: return [2 /*return*/, _a.sent()];
             }
@@ -374,4 +374,4 @@ var useScreeb = function () {
 
 exports.ScreebProvider = ScreebProvider;
 exports.useScreeb = useScreeb;
-CONSTANTS.version = '0.1.10'
+CONSTANTS.version = '0.1.11'

package/dist/cjs/types.d.ts

@@ -9,6 +9,8 @@ export type ScreebProps = {
     userProperties?: PropertyRecord;
     /** Hooks to define callback for various event */
     hooks?: Hooks;
+    /** The language you want to force */
+    language?: string;
 };
 /**
  * Shutdowns current Screeb session.
@@ -234,6 +236,7 @@ export type IdentityResetFunction = () => Promise<unknown>;
  *   - No more than 1000 attributes
  *   - Supported types for values: string, number, boolean and Date
  * ```
+ * @param language Force a specific language for the tag. eg: 'en'. default: browser language.
  *
  * @example
  * ```ts
@@ -248,11 +251,12 @@ export type IdentityResetFunction = () => Promise<unknown>;
  *     plan: '<user-plan>',
  *     last_seen_at: new Date(),
  *     authenticated: true
- *   }
+ *   },
+ *   "en"
  * );
  * ```
  */
-export type InitFunction = (websiteId: string, userId?: string, userProperties?: PropertyRecord) => Promise<void>;
+export type InitFunction = (websiteId: string, userId?: string, userProperties?: PropertyRecord, hooks?: Hooks, language?: string) => Promise<void>;
 /**
  * Appends Screeb tag into your dom.
  *
@@ -296,7 +300,7 @@ export type SurveyCloseFunction = () => Promise<unknown>;
  * );
  * ```
  */
-export type SurveyStartFunction = (surveyId: string, allowMultipleResponses: boolean, hiddenFields: PropertyRecord) => Promise<unknown>;
+export type SurveyStartFunction = (surveyId: string, allowMultipleResponses: boolean, hiddenFields: PropertyRecord, hooks: Hooks, language: string) => Promise<unknown>;
 /**
  * Forces a targeting check.
  *

package/dist/es/index.mjs

@@ -119,7 +119,7 @@ var isSSR = typeof window === "undefined";
 var CONSTANTS = { version: "0.0.0-dev" };
 var isInitialized = false;
 var ScreebProvider = function (_a) {
-    var websiteId = _a.websiteId, userId = _a.userId, userProperties = _a.userProperties, hooks = _a.hooks, children = _a.children, _b = _a.shouldLoad, shouldLoad = _b === void 0 ? !isSSR : _b, _c = _a.autoInit, autoInit = _c === void 0 ? false : _c, options = _a.options, rest = __rest(_a, ["websiteId", "userId", "userProperties", "hooks", "children", "shouldLoad", "autoInit", "options"]);
+    var websiteId = _a.websiteId, userId = _a.userId, userProperties = _a.userProperties, hooks = _a.hooks, language = _a.language, children = _a.children, _b = _a.shouldLoad, shouldLoad = _b === void 0 ? !isSSR : _b, _c = _a.autoInit, autoInit = _c === void 0 ? false : _c, options = _a.options, rest = __rest(_a, ["websiteId", "userId", "userProperties", "hooks", "language", "children", "shouldLoad", "autoInit", "options"]);
     var isLoaded = React.useRef(Screeb.isLoaded());
     // Allow data-x attributes, see https://github.com/devrnt/react-use-screeb/issues/478
     var invalidPropKeys = Object.keys(rest).filter(function (key) { return !key.startsWith("data-"); });
@@ -236,12 +236,12 @@ var ScreebProvider = function (_a) {
             case 1: return [2 /*return*/, _a.sent()];
         }
     }); }); }, []);
-    var init = React.useCallback(function (websiteId, userId, userProperties, hooks) { return __awaiter(void 0, void 0, void 0, function () {
+    var init = React.useCallback(function (websiteId, userId, userProperties, hooks, language) { return __awaiter(void 0, void 0, void 0, function () {
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, ensureScreeb("init", function () {
                         if (!isInitialized) {
-                            Screeb.init(websiteId, userId, userProperties, hooks);
+                            Screeb.init(websiteId, userId, userProperties, hooks, language);
                             isInitialized = true;
                         }
                     }, true)];
@@ -260,7 +260,7 @@ var ScreebProvider = function (_a) {
                     isLoaded.current = true;
                     if (!autoInit) return [3 /*break*/, 3];
                     if (!websiteId) return [3 /*break*/, 2];
-                    return [4 /*yield*/, init(websiteId, userId, userProperties, hooks)];
+                    return [4 /*yield*/, init(websiteId, userId, userProperties, hooks, language)];
                 case 1:
                     _a.sent();
                     return [3 /*break*/, 3];
@@ -277,11 +277,11 @@ var ScreebProvider = function (_a) {
             case 1: return [2 /*return*/, _a.sent()];
         }
     }); }); }, []);
-    var surveyStart = React.useCallback(function (surveyId, allowMultipleResponses, hiddenFields, hooks) { return __awaiter(void 0, void 0, void 0, function () {
+    var surveyStart = React.useCallback(function (surveyId, allowMultipleResponses, hiddenFields, hooks, language) { return __awaiter(void 0, void 0, void 0, function () {
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, ensureScreeb("surveyStart", function () {
-                        return Screeb.surveyStart(surveyId, allowMultipleResponses, hiddenFields, hooks);
+                        return Screeb.surveyStart(surveyId, allowMultipleResponses, hiddenFields, hooks, language);
                     })];
                 case 1: return [2 /*return*/, _a.sent()];
             }
@@ -351,4 +351,4 @@ var useScreeb = function () {
 };
 
 export { ScreebProvider, useScreeb };
-CONSTANTS.version = '0.1.10'
+CONSTANTS.version = '0.1.11'

package/dist/es/types.d.ts

@@ -9,6 +9,8 @@ export type ScreebProps = {
     userProperties?: PropertyRecord;
     /** Hooks to define callback for various event */
     hooks?: Hooks;
+    /** The language you want to force */
+    language?: string;
 };
 /**
  * Shutdowns current Screeb session.
@@ -234,6 +236,7 @@ export type IdentityResetFunction = () => Promise<unknown>;
  *   - No more than 1000 attributes
  *   - Supported types for values: string, number, boolean and Date
  * ```
+ * @param language Force a specific language for the tag. eg: 'en'. default: browser language.
  *
  * @example
  * ```ts
@@ -248,11 +251,12 @@ export type IdentityResetFunction = () => Promise<unknown>;
  *     plan: '<user-plan>',
  *     last_seen_at: new Date(),
  *     authenticated: true
- *   }
+ *   },
+ *   "en"
  * );
  * ```
  */
-export type InitFunction = (websiteId: string, userId?: string, userProperties?: PropertyRecord) => Promise<void>;
+export type InitFunction = (websiteId: string, userId?: string, userProperties?: PropertyRecord, hooks?: Hooks, language?: string) => Promise<void>;
 /**
  * Appends Screeb tag into your dom.
  *
@@ -296,7 +300,7 @@ export type SurveyCloseFunction = () => Promise<unknown>;
  * );
  * ```
  */
-export type SurveyStartFunction = (surveyId: string, allowMultipleResponses: boolean, hiddenFields: PropertyRecord) => Promise<unknown>;
+export type SurveyStartFunction = (surveyId: string, allowMultipleResponses: boolean, hiddenFields: PropertyRecord, hooks: Hooks, language: string) => Promise<unknown>;
 /**
  * Forces a targeting check.
  *

package/docs/README.md

@@ -34,18 +34,10 @@
 
 ### CloseFunction
 
-Ƭ **CloseFunction**: () => `Promise`<`void`\>
-
-#### Type declaration
-
-▸ (): `Promise`<`void`\>
+Ƭ **CloseFunction**: () => `Promise`\<`void`\>
 
 Shutdowns current Screeb session.
 
-##### Returns
-
-`Promise`<`void`\>
-
 **`Example`**
 
 ```ts
@@ -54,21 +46,21 @@ const { close } = useScreeb();
 close();
 ```
 
-___
+#### Type declaration
 
-### DebugFunction
+▸ (): `Promise`\<`void`\>
 
-Ƭ **DebugFunction**: () => `Promise`<`unknown`\>
+##### Returns
 
-#### Type declaration
+`Promise`\<`void`\>
 
-▸ (): `Promise`<`unknown`\>
+___
 
-Prints the actual state information of Screeb tag.
+### DebugFunction
 
-##### Returns
+Ƭ **DebugFunction**: () => `Promise`\<`unknown`\>
 
-`Promise`<`unknown`\>
+Prints the actual state information of Screeb tag.
 
 **`Example`**
 
@@ -95,28 +87,21 @@ debug();
 // **************************************************************
 ```
 
-___
-
-### EventTrackFunction
-
-Ƭ **EventTrackFunction**: (`eventName`: `string`, `eventProperties?`: `PropertyRecord`) => `Promise`<`unknown`\>
-
 #### Type declaration
 
-▸ (`eventName`, `eventProperties?`): `Promise`<`unknown`\>
+▸ (): `Promise`\<`unknown`\>
 
-Tracks a user event.
+##### Returns
 
-##### Parameters
+`Promise`\<`unknown`\>
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName` | `string` | The event name. |
-| `eventProperties?` | `PropertyRecord` | 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. ``` |
+___
 
-##### Returns
+### EventTrackFunction
+
+Ƭ **EventTrackFunction**: (`eventName`: `string`, `eventProperties?`: `PropertyRecord`) => `Promise`\<`unknown`\>
 
-`Promise`<`unknown`\>
+Tracks a user event.
 
 **`Example`**
 
@@ -139,29 +124,29 @@ eventTrack(
 );
 ```
 
-___
-
-### IdentityFunction
-
-Ƭ **IdentityFunction**: (`userId`: `string`, `userProperties?`: `PropertyRecord`) => `Promise`<`unknown`\>
-
 #### Type declaration
 
-▸ (`userId`, `userProperties?`): `Promise`<`unknown`\>
-
-Change the current user identity.
-Warning: Running surveys will be closed.
+▸ (`eventName`, `eventProperties?`): `Promise`\<`unknown`\>
 
 ##### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `userId` | `string` | The unique identifier of your user. |
-| `userProperties?` | `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. ``` |
+| `eventName` | `string` | The event name. |
+| `eventProperties?` | `PropertyRecord` | 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. ``` |
 
 ##### Returns
 
-`Promise`<`unknown`\>
+`Promise`\<`unknown`\>
+
+___
+
+### IdentityFunction
+
+Ƭ **IdentityFunction**: (`userId`: `string`, `userProperties?`: `PropertyRecord`) => `Promise`\<`unknown`\>
+
+Change the current user identity.
+Warning: Running surveys will be closed.
 
 **`Example`**
 
@@ -180,21 +165,28 @@ identity(
 );
 ```
 
-___
+#### Type declaration
 
-### IdentityGetFunction
+▸ (`userId`, `userProperties?`): `Promise`\<`unknown`\>
 
-Ƭ **IdentityGetFunction**: () => `Promise`<`ScreebIdentityGetReturn`\>
+##### Parameters
 
-#### Type declaration
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `userId` | `string` | The unique identifier of your user. |
+| `userProperties?` | `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. ``` |
 
-▸ (): `Promise`<`ScreebIdentityGetReturn`\>
+##### Returns
 
-Retrieves the current user identity.
+`Promise`\<`unknown`\>
 
-##### Returns
+___
+
+### IdentityGetFunction
 
-`Promise`<`ScreebIdentityGetReturn`\>
+Ƭ **IdentityGetFunction**: () => `Promise`\<`ScreebIdentityGetReturn`\>
+
+Retrieves the current user identity.
 
 **`Example`**
 
@@ -213,29 +205,21 @@ console.log(await identityGet());
 // }
 ```
 
-___
-
-### IdentityGroupAssignFunction
-
-Ƭ **IdentityGroupAssignFunction**: (`groupName`: `string`, `groupType?`: `string`, `groupProperties?`: `PropertyRecord`) => `Promise`<`unknown`\>
-
 #### Type declaration
 
-▸ (`groupName`, `groupType?`, `groupProperties?`): `Promise`<`unknown`\>
+▸ (): `Promise`\<`ScreebIdentityGetReturn`\>
 
-Assigns the current user to a group.
+##### Returns
 
-##### Parameters
+`Promise`\<`ScreebIdentityGetReturn`\>
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `groupName` | `string` |  |
-| `groupType?` | `string` |  |
-| `groupProperties?` | `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
+### IdentityGroupAssignFunction
 
-`Promise`<`unknown`\>
+Ƭ **IdentityGroupAssignFunction**: (`groupName`: `string`, `groupType?`: `string`, `groupProperties?`: `PropertyRecord`) => `Promise`\<`unknown`\>
+
+Assigns the current user to a group.
 
 **`Example`**
 
@@ -256,28 +240,29 @@ identityGroupAssign(
 );
 ```
 
-___
-
-### IdentityGroupUnassignFunction
-
-Ƭ **IdentityGroupUnassignFunction**: (`groupName`: `string`, `groupType?`: `string`) => `Promise`<`unknown`\>
-
 #### Type declaration
 
-▸ (`groupName`, `groupType?`): `Promise`<`unknown`\>
-
-Unassigns the current user to a group.
+▸ (`groupName`, `groupType?`, `groupProperties?`): `Promise`\<`unknown`\>
 
 ##### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `groupName` | `string` | The name of your user group. |
-| `groupType?` | `string` | The type of your user group. |
+| `groupName` | `string` |  |
+| `groupType?` | `string` |  |
+| `groupProperties?` | `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
 
-`Promise`<`unknown`\>
+`Promise`\<`unknown`\>
+
+___
+
+### IdentityGroupUnassignFunction
+
+Ƭ **IdentityGroupUnassignFunction**: (`groupName`: `string`, `groupType?`: `string`) => `Promise`\<`unknown`\>
+
+Unassigns the current user to a group.
 
 **`Example`**
 
@@ -287,27 +272,28 @@ const { identityGroupUnassign } = useScreeb();
 identityGroupUnassign('company', 'Apple');
 ```
 
-___
-
-### IdentityPropertiesFunction
-
-Ƭ **IdentityPropertiesFunction**: (`userProperties`: `PropertyRecord`) => `Promise`<`unknown`\>
-
 #### Type declaration
 
-▸ (`userProperties`): `Promise`<`unknown`\>
-
-Adds properties to the current user identity.
+▸ (`groupName`, `groupType?`): `Promise`\<`unknown`\>
 
 ##### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `userProperties` | `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. ``` |
+| `groupName` | `string` | The name of your user group. |
+| `groupType?` | `string` | The type of your user group. |
 
 ##### Returns
 
-`Promise`<`unknown`\>
+`Promise`\<`unknown`\>
+
+___
+
+### IdentityPropertiesFunction
+
+Ƭ **IdentityPropertiesFunction**: (`userProperties`: `PropertyRecord`) => `Promise`\<`unknown`\>
+
+Adds properties to the current user identity.
 
 **`Example`**
 
@@ -335,22 +321,28 @@ identityProperties(
 );
 ```
 
-___
+#### Type declaration
 
-### IdentityResetFunction
+▸ (`userProperties`): `Promise`\<`unknown`\>
 
-Ƭ **IdentityResetFunction**: () => `Promise`<`unknown`\>
+##### Parameters
 
-#### Type declaration
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `userProperties` | `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. ``` |
 
-▸ (): `Promise`<`unknown`\>
+##### Returns
 
-Resets the current user identity.
-Warning: This command must be called only once, since it creates a new identity on Screeb side.
+`Promise`\<`unknown`\>
 
-##### Returns
+___
+
+### IdentityResetFunction
 
-`Promise`<`unknown`\>
+Ƭ **IdentityResetFunction**: () => `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`**
 
@@ -360,29 +352,21 @@ const { identityReset } = useScreeb();
 identityReset();
 ```
 
-___
-
-### InitFunction
-
-Ƭ **InitFunction**: (`websiteId`: `string`, `userId?`: `string`, `userProperties?`: `PropertyRecord`) => `Promise`<`void`\>
-
 #### Type declaration
 
-▸ (`websiteId`, `userId?`, `userProperties?`): `Promise`<`void`\>
+▸ (): `Promise`\<`unknown`\>
 
-Initializes Screeb tag.
+##### Returns
 
-##### Parameters
+`Promise`\<`unknown`\>
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `websiteId` | `string` | Your website/channel id. |
-| `userId?` | `string` | The unique identifier of your user. |
-| `userProperties?` | `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
+### InitFunction
 
-`Promise`<`void`\>
+Ƭ **InitFunction**: (`websiteId`: `string`, `userId?`: `string`, `userProperties?`: `PropertyRecord`, `hooks?`: `Hooks`, `language?`: `string`) => `Promise`\<`void`\>
+
+Initializes Screeb tag.
 
 **`Example`**
 
@@ -398,31 +382,36 @@ init(
     plan: '<user-plan>',
     last_seen_at: new Date(),
     authenticated: true
-  }
+  },
+  "en"
 );
 ```
 
-___
-
-### LoadFunction
-
-Ƭ **LoadFunction**: (`options?`: `ScreebOptions`) => `Promise`<`void`\>
-
 #### Type declaration
 
-▸ (`options?`): `Promise`<`void`\>
-
-Appends Screeb tag into your dom.
+▸ (`websiteId`, `userId?`, `userProperties?`, `hooks?`, `language?`): `Promise`\<`void`\>
 
 ##### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `options?` | `ScreebOptions` | Screeb module options. |
+| `websiteId` | `string` | Your website/channel id. |
+| `userId?` | `string` | The unique identifier of your user. |
+| `userProperties?` | `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` | - |
+| `language?` | `string` | Force a specific language for the tag. eg: 'en'. default: browser language. |
 
 ##### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
+
+___
+
+### LoadFunction
+
+Ƭ **LoadFunction**: (`options?`: `ScreebOptions`) => `Promise`\<`void`\>
+
+Appends Screeb tag into your dom.
 
 **`Example`**
 
@@ -432,6 +421,20 @@ const { load } = useScreeb();
 load();
 ```
 
+#### Type declaration
+
+▸ (`options?`): `Promise`\<`void`\>
+
+##### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `options?` | `ScreebOptions` | Screeb module options. |
+
+##### Returns
+
+`Promise`\<`void`\>
+
 ___
 
 ### ScreebContextValues
@@ -473,6 +476,7 @@ Properties of Screeb provider
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `hooks?` | `Hooks` | Hooks to define callback for various event |
+| `language?` | `string` | The language you want to force |
 | `userId?` | `string` | The unique identifier of your user. |
 | `userProperties?` | `PropertyRecord` | The properties of your user. |
 | `websiteId` | `string` | Your website/channel id. |
@@ -481,7 +485,7 @@ ___
 
 ### ScreebProviderProps
 
-Ƭ **ScreebProviderProps**: { `autoInit?`: `boolean` ; `options?`: `ScreebOptions` ; `shouldLoad?`: `boolean`  } & `Partial`<[`ScreebProps`](README.md#screebprops)\>
+Ƭ **ScreebProviderProps**: \{ `autoInit?`: `boolean` ; `options?`: `ScreebOptions` ; `shouldLoad?`: `boolean`  } & `Partial`\<[`ScreebProps`](README.md#screebprops)\>
 
 Properties of Screeb provider
 
@@ -489,18 +493,10 @@ ___
 
 ### SurveyCloseFunction
 
-Ƭ **SurveyCloseFunction**: () => `Promise`<`unknown`\>
-
-#### Type declaration
-
-▸ (): `Promise`<`unknown`\>
+Ƭ **SurveyCloseFunction**: () => `Promise`\<`unknown`\>
 
 Interrupts a running survey.
 
-##### Returns
-
-`Promise`<`unknown`\>
-
 **`Example`**
 
 ```ts
@@ -509,29 +505,21 @@ const { surveyClose } = useScreeb();
 surveyClose();
 ```
 
-___
-
-### SurveyStartFunction
-
-Ƭ **SurveyStartFunction**: (`surveyId`: `string`, `allowMultipleResponses`: `boolean`, `hiddenFields`: `PropertyRecord`) => `Promise`<`unknown`\>
-
 #### Type declaration
 
-▸ (`surveyId`, `allowMultipleResponses`, `hiddenFields`): `Promise`<`unknown`\>
+▸ (): `Promise`\<`unknown`\>
 
-Starts a survey by its ID.
+##### Returns
 
-##### Parameters
+`Promise`\<`unknown`\>
 
-| Name | Type |
-| :------ | :------ |
-| `surveyId` | `string` |
-| `allowMultipleResponses` | `boolean` |
-| `hiddenFields` | `PropertyRecord` |
+___
 
-##### Returns
+### SurveyStartFunction
+
+Ƭ **SurveyStartFunction**: (`surveyId`: `string`, `allowMultipleResponses`: `boolean`, `hiddenFields`: `PropertyRecord`, `hooks`: `Hooks`, `language`: `string`) => `Promise`\<`unknown`\>
 
-`Promise`<`unknown`\>
+Starts a survey by its ID.
 
 **`Example`**
 
@@ -548,21 +536,31 @@ surveyStart(
 );
 ```
 
-___
+#### Type declaration
 
-### TargetingCheckFunction
+▸ (`surveyId`, `allowMultipleResponses`, `hiddenFields`, `hooks`, `language`): `Promise`\<`unknown`\>
 
-Ƭ **TargetingCheckFunction**: () => `Promise`<`unknown`\>
+##### Parameters
 
-#### Type declaration
+| Name | Type |
+| :------ | :------ |
+| `surveyId` | `string` |
+| `allowMultipleResponses` | `boolean` |
+| `hiddenFields` | `PropertyRecord` |
+| `hooks` | `Hooks` |
+| `language` | `string` |
+
+##### Returns
 
-▸ (): `Promise`<`unknown`\>
+`Promise`\<`unknown`\>
 
-Forces a targeting check.
+___
 
-##### Returns
+### TargetingCheckFunction
+
+Ƭ **TargetingCheckFunction**: () => `Promise`\<`unknown`\>
 
-`Promise`<`unknown`\>
+Forces a targeting check.
 
 **`Example`**
 
@@ -572,21 +570,21 @@ const { targetingCheck } = useScreeb();
 targetingCheck();
 ```
 
-___
+#### Type declaration
 
-### TargetingDebugFunction
+▸ (): `Promise`\<`unknown`\>
 
-Ƭ **TargetingDebugFunction**: () => `Promise`<`unknown`\>
+##### Returns
 
-#### Type declaration
+`Promise`\<`unknown`\>
 
-▸ (): `Promise`<`unknown`\>
+___
 
-Prints the current state of the targeting engine.
+### TargetingDebugFunction
 
-##### Returns
+Ƭ **TargetingDebugFunction**: () => `Promise`\<`unknown`\>
 
-`Promise`<`unknown`\>
+Prints the current state of the targeting engine.
 
 **`Example`**
 
@@ -610,18 +608,26 @@ console.log(await targetingDebug());
 //   - Rule of type "Capping per respondent display count": false 🔴
 ```
 
+#### Type declaration
+
+▸ (): `Promise`\<`unknown`\>
+
+##### Returns
+
+`Promise`\<`unknown`\>
+
 ## Functions
 
 ### ScreebProvider
 
-▸ **ScreebProvider**(`props`, `context?`): `ReactNode`
+▸ **ScreebProvider**(`props`, `deprecatedLegacyContext?`): `ReactNode`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `props` | `PropsWithChildren`<[`ScreebProviderProps`](README.md#screebproviderprops)\> |
-| `context?` | `any` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `props` | `PropsWithChildren`\<[`ScreebProviderProps`](README.md#screebproviderprops)\> | - |
+| `deprecatedLegacyContext?` | `any` | **`Deprecated`** **`See`** [React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) |
 
 #### Returns
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@screeb/sdk-react",
-  "version": "0.1.10",
+  "version": "0.1.11",
   "description": "Screeb's browser sdk, optimized for React.",
   "keywords": [
     "product discovery",
@@ -41,7 +41,7 @@
     "test": "echo '@TODO'"
   },
   "dependencies": {
-    "@screeb/sdk-browser": "^0.1.16"
+    "@screeb/sdk-browser": "^0.1.17"
   },
   "devDependencies": {
     "@screeb/eslint-config": "^0.1.6",

package/readme/screeb-logo.svg

@@ -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>