feat(*): force language

ScreebApp · Sep 24, 2024 · cc646ae · cc646ae
1 parent dbe90a2
commit cc646ae
Show file tree

Hide file tree

Showing 7 changed files with 57 additions and 15 deletions.
diff --git a/packages/screeb-sdk-angular/docs/classes/Screeb.md b/packages/screeb-sdk-angular/docs/classes/Screeb.md
@@ -353,7 +353,7 @@ ___
 
 ### init
 
-▸ **init**(`websiteId`, `userId?`, `userProperties?`, `hooks?`): `Promise`<`unknown`\>
+▸ **init**(`websiteId`, `userId?`, `userProperties?`, `hooks?`, `forceLang?`): `Promise`<`unknown`\>
 
 Initializes Screeb tag.
 
@@ -365,6 +365,7 @@ Initializes Screeb tag.
 | `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` | - |
+| `forceLang?` | `string` | - |
 
 #### Returns
 
@@ -436,7 +437,7 @@ ___
 
 ### surveyStart
 
-▸ **surveyStart**(`surveyId`, `allowMultipleResponses`, `hiddenFields`, `hooks?`): `Promise`<`unknown`\>
+▸ **surveyStart**(`surveyId`, `allowMultipleResponses`, `hiddenFields`, `hooks?`, `forceLang?`): `Promise`<`unknown`\>
 
 Starts a survey by its ID.
 
@@ -448,6 +449,7 @@ Starts a survey by its ID.
 | `allowMultipleResponses` | `boolean` |
 | `hiddenFields` | `PropertyRecord` |
 | `hooks?` | `Hooks` |
+| `forceLang?` | `string` |
 
 #### Returns
 

diff --git a/packages/screeb-sdk-angular/projects/screeb-sdk-angular/src/lib/screeb.ts b/packages/screeb-sdk-angular/projects/screeb-sdk-angular/src/lib/screeb.ts
@@ -322,15 +322,17 @@ export class Screeb {
     surveyId: string,
     allowMultipleResponses: boolean,
     hiddenFields: _Screeb.PropertyRecord,
-    hooks?: _Screeb.Hooks
+    hooks?: _Screeb.Hooks,
+    forceLang?: string
   ) {
     await this.ensureScreeb("surveyStart");
 
     return _Screeb.surveyStart(
       surveyId,
       allowMultipleResponses,
       hiddenFields,
-      hooks
+      hooks,
+      forceLang
     );
   }
 
@@ -411,13 +413,20 @@ export class Screeb {
     websiteId: string,
     userId?: string,
     userProperties?: _Screeb.PropertyRecord,
-    hooks?: _Screeb.Hooks
+    hooks?: _Screeb.Hooks,
+    forceLang?: string
   ) {
     await this.ensureScreeb("init", true);
 
     this.isInitialized = true;
 
-    return await _Screeb.init(websiteId, userId, userProperties, hooks);
+    return await _Screeb.init(
+      websiteId,
+      userId,
+      userProperties,
+      hooks,
+      forceLang
+    );
   }
 
   /**

diff --git a/packages/screeb-sdk-browser/docs/README.md b/packages/screeb-sdk-browser/docs/README.md
@@ -702,7 +702,7 @@ ___
 
 ### init
 
-▸ **init**(`websiteId`, `userId?`, `userProperties?`, `hooks?`): `void` \| `Promise`<`unknown`\>
+▸ **init**(`websiteId`, `userId?`, `userProperties?`, `hooks?`, `forceLang?`): `void` \| `Promise`<`unknown`\>
 
 Initializes Screeb tag.
 
@@ -714,6 +714,7 @@ 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. |
+| `forceLang?` | `string` | - |
 
 #### Returns
 
@@ -813,7 +814,7 @@ ___
 
 ### surveyStart
 
-▸ **surveyStart**(`surveyId`, `allowMultipleResponses?`, `hiddenFields?`, `hooks?`): `void` \| `Promise`<`unknown`\>
+▸ **surveyStart**(`surveyId`, `allowMultipleResponses?`, `hiddenFields?`, `hooks?`, `forceLang?`): `void` \| `Promise`<`unknown`\>
 
 Starts a survey by its ID.
 
@@ -825,6 +826,7 @@ Starts a survey by its ID.
 | `allowMultipleResponses` | `boolean` | `true` |
 | `hiddenFields` | [`PropertyRecord`](README.md#propertyrecord) | `{}` |
 | `hooks?` | [`Hooks`](README.md#hooks) | `undefined` |
+| `forceLang?` | `string` | `undefined` |
 
 #### Returns
 

diff --git a/packages/screeb-sdk-browser/src/index.ts b/packages/screeb-sdk-browser/src/index.ts
@@ -126,8 +126,15 @@ export const init = (
   userId?: string,
   userProperties?: PropertyRecord,
   hooks?: Hooks,
+  forceLang?: string,
 ) => {
-  let identityObject;
+  let identityObject:
+    | {
+        hooks?: Hooks;
+        identity?: { id?: string; properties?: PropertyRecord };
+        forceLang?: string;
+      }
+    | undefined;
 
   if (userId || userProperties) {
     identityObject = {
@@ -139,6 +146,10 @@ export const init = (
     };
   }
 
+  if (forceLang) {
+    identityObject = { ...identityObject, forceLang };
+  }
+
   return callScreebCommand("init", websiteId, identityObject);
 };
 
@@ -434,9 +445,11 @@ export const surveyStart = (
   allowMultipleResponses = true,
   hiddenFields: PropertyRecord = {},
   hooks?: Hooks,
+  forceLang?: string,
 ) =>
   callScreebCommand("survey.start", surveyId, {
     allow_multiple_responses: allowMultipleResponses,
+    forceLang: forceLang,
     hidden_fields: hiddenFields,
     hooks: hooks,
   });

diff --git a/packages/screeb-sdk-react/docs/README.md b/packages/screeb-sdk-react/docs/README.md
@@ -364,11 +364,11 @@ ___
 
 ### InitFunction
 
-Ƭ **InitFunction**: (`websiteId`: `string`, `userId?`: `string`, `userProperties?`: `PropertyRecord`) => `Promise`<`void`\>
+Ƭ **InitFunction**: (`websiteId`: `string`, `userId?`: `string`, `userProperties?`: `PropertyRecord`, `hooks?`: `Hooks`, `forceLang?`: `string`) => `Promise`<`void`\>
 
 #### Type declaration
 
-▸ (`websiteId`, `userId?`, `userProperties?`): `Promise`<`void`\>
+▸ (`websiteId`, `userId?`, `userProperties?`, `hooks?`, `forceLang?`): `Promise`<`void`\>
 
 Initializes Screeb tag.
 
@@ -379,6 +379,8 @@ Initializes Screeb tag.
 | `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` | - |
+| `forceLang?` | `string` | Force the language of the tag. |
 
 ##### Returns
 
@@ -472,6 +474,7 @@ Properties of Screeb provider
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
+| `forceLang?` | `string` | The language you want to force |
 | `hooks?` | `Hooks` | Hooks to define callback for various event |
 | `userId?` | `string` | The unique identifier of your user. |
 | `userProperties?` | `PropertyRecord` | The properties of your user. |
@@ -513,11 +516,11 @@ ___
 
 ### SurveyStartFunction
 
-Ƭ **SurveyStartFunction**: (`surveyId`: `string`, `allowMultipleResponses`: `boolean`, `hiddenFields`: `PropertyRecord`) => `Promise`<`unknown`\>
+Ƭ **SurveyStartFunction**: (`surveyId`: `string`, `allowMultipleResponses`: `boolean`, `hiddenFields`: `PropertyRecord`, `hooks`: `Hooks`, `forceLang`: `string`) => `Promise`<`unknown`\>
 
 #### Type declaration
 
-▸ (`surveyId`, `allowMultipleResponses`, `hiddenFields`): `Promise`<`unknown`\>
+▸ (`surveyId`, `allowMultipleResponses`, `hiddenFields`, `hooks`, `forceLang`): `Promise`<`unknown`\>
 
 Starts a survey by its ID.
 
@@ -528,6 +531,8 @@ Starts a survey by its ID.
 | `surveyId` | `string` |
 | `allowMultipleResponses` | `boolean` |
 | `hiddenFields` | `PropertyRecord` |
+| `hooks` | `Hooks` |
+| `forceLang` | `string` |
 
 ##### Returns
 

diff --git a/packages/screeb-sdk-react/src/provider.tsx b/packages/screeb-sdk-react/src/provider.tsx
@@ -17,6 +17,7 @@ export const ScreebProvider: React.FC<
   userId,
   userProperties,
   hooks,
+  forceLang,
   children,
   shouldLoad = !isSSR,
   autoInit = false,
@@ -145,12 +146,13 @@ export const ScreebProvider: React.FC<
       userId?: string,
       userProperties?: Screeb.PropertyRecord,
       hooks?: Screeb.Hooks,
+      forceLang?: string,
     ) => {
       await ensureScreeb(
         "init",
         () => {
           if (!isInitialized) {
-            Screeb.init(websiteId, userId, userProperties, hooks);
+            Screeb.init(websiteId, userId, userProperties, hooks, forceLang);
 
             isInitialized = true;
           }
@@ -174,7 +176,7 @@ export const ScreebProvider: React.FC<
 
         if (autoInit) {
           if (websiteId) {
-            await init(websiteId, userId, userProperties, hooks);
+            await init(websiteId, userId, userProperties, hooks, forceLang);
           } else {
             logger.log(
               "warn",
@@ -198,13 +200,15 @@ export const ScreebProvider: React.FC<
       allowMultipleResponses: boolean,
       hiddenFields: Screeb.PropertyRecord,
       hooks?: Screeb.Hooks,
+      forceLang?: string,
     ) =>
       await ensureScreeb("surveyStart", () =>
         Screeb.surveyStart(
           surveyId,
           allowMultipleResponses,
           hiddenFields,
           hooks,
+          forceLang,
         ),
       ),
     [],

diff --git a/packages/screeb-sdk-react/src/types.ts b/packages/screeb-sdk-react/src/types.ts
@@ -16,6 +16,8 @@ export type ScreebProps = {
   userProperties?: PropertyRecord;
   /** Hooks to define callback for various event */
   hooks?: Hooks;
+  /** The language you want to force */
+  forceLang?: string;
 };
 
 /**
@@ -266,6 +268,7 @@ export type IdentityResetFunction = () => Promise<unknown>;
  *   - No more than 1000 attributes
  *   - Supported types for values: string, number, boolean and Date
  * ```
+ * @param forceLang Force the language of the tag.
  *
  * @example
  * ```ts
@@ -288,6 +291,8 @@ export type InitFunction = (
   websiteId: string,
   userId?: string,
   userProperties?: PropertyRecord,
+  hooks?: Hooks,
+  forceLang?: string,
 ) => Promise<void>;
 
 /**
@@ -339,6 +344,8 @@ export type SurveyStartFunction = (
   surveyId: string,
   allowMultipleResponses: boolean,
   hiddenFields: PropertyRecord,
+  hooks: Hooks,
+  forceLang: string,
 ) => Promise<unknown>;
 
 /**