@botfabrik/engine-webclient 4.43.1 → 4.44.1

package/README.md

@@ -32,14 +32,14 @@ Beispiel:
 
 ```typescript
 export default async (querystrings: any): Promise<any> => {
-    const accessToken = querystrings.accessToken;
-    const userProfile: UserProfile = await fetchUserProfile(accessToken);
-
-    return {
-        id: userProfile.username + '@' + userProfile.domain,
-        displayName: userProfile.firstName + ' ' + userProfile.lastName,
-        payload: userProfile,
-    };
+  const accessToken = querystrings.accessToken;
+  const userProfile: UserProfile = await fetchUserProfile(accessToken);
+
+  return {
+    id: userProfile.username + '@' + userProfile.domain,
+    displayName: userProfile.firstName + ' ' + userProfile.lastName,
+    payload: userProfile,
+  };
 };
 ```
 
@@ -54,11 +54,11 @@ Beispiel:
 
 ```typescript
 export default async (querystrings: any): Promise<any> => {
-    const accessToken = querystrings.accessToken;
-    const userProfile: UserProfile = await fetchUserProfile(accessToken);
-    return {
-        'sessionInfo.user.id': userProfile.username + '@' + userProfile.domain,
-    };
+  const accessToken = querystrings.accessToken;
+  const userProfile: UserProfile = await fetchUserProfile(accessToken);
+  return {
+    'sessionInfo.user.id': userProfile.username + '@' + userProfile.domain,
+  };
 };
 ```
 
@@ -68,27 +68,27 @@ Aktiviert die Sprachsteuerung
 
 Folgende Parameter müssen mitgegeben werden:
 
--   clientEmail
--   privateKey
+- clientEmail
+- privateKey
 
 Folgende Parameter sind optional:
 
--   contextPhrases: Hier können Wörter und Sätze angegeben werden, welche in diesem Kontext häufig verwendet werden. So kann z.B. sichergestellt werden, dass bei der Umwandlung von Sprache zu Text "Botfabrik" und nicht "Brotfabrik" rauskommt. Texte können pro Locale erfasst werden.
+- contextPhrases: Hier können Wörter und Sätze angegeben werden, welche in diesem Kontext häufig verwendet werden. So kann z.B. sichergestellt werden, dass bei der Umwandlung von Sprache zu Text "Botfabrik" und nicht "Brotfabrik" rauskommt. Texte können pro Locale erfasst werden.
 
 Beispiel:
 
 ```typescript
 const webclientProps = {
-    getStartedAction: requestNLUEvent('WELCOME'),
-    speech: process.env.GOOGLE_CLOUD_SPEECH_PRIVATE_KEY
-        ? {
-              clientEmail: process.env.GOOGLE_CLOUD_SPEECH_CLIENT_EMAIL || '',
-              privateKey: process.env.GOOGLE_CLOUD_SPEECH_PRIVATE_KEY || '',
-              contextPhrases: {
-                  de: ['Bot', 'Was ist die Botfabrik?', 'Botfabrik'],
-              },
-          }
-        : undefined,
+  getStartedAction: requestNLUEvent('WELCOME'),
+  speech: process.env.GOOGLE_CLOUD_SPEECH_PRIVATE_KEY
+    ? {
+        clientEmail: process.env.GOOGLE_CLOUD_SPEECH_CLIENT_EMAIL || '',
+        privateKey: process.env.GOOGLE_CLOUD_SPEECH_PRIVATE_KEY || '',
+        contextPhrases: {
+          de: ['Bot', 'Was ist die Botfabrik?', 'Botfabrik'],
+        },
+      }
+    : undefined,
 };
 bot.addClient(Webclient('webclient', webclientProps));
 ```
@@ -102,8 +102,8 @@ Beispiel:
 
 ```typescript
 const webclientProps = {
-    getStartedAction: requestNLUEvent('Welcome'),
-    expandChatWindowAtStart: Devices.Desktop,
+  getStartedAction: requestNLUEvent('Welcome'),
+  expandChatWindowAtStart: Devices.Desktop,
 };
 bot.addClient(Webclient('webclient', webclientProps));
 ```
@@ -118,8 +118,8 @@ Beispiel:
 import { requestNLUEvent } from '@botfabrik/engine-core';
 
 const webclientProps = {
-    getStartedAction: requestNLUEvent('WELCOME'),
-    emailExportEnabled: true,
+  getStartedAction: requestNLUEvent('WELCOME'),
+  emailExportEnabled: true,
 };
 
 bot.addClient(Webclient('webclient', webclientProps));
@@ -133,7 +133,7 @@ Beispiel:
 
 ```typescript
 const webclientProps = {
-    pdfExportEnabled: true,
+  pdfExportEnabled: true,
 };
 
 bot.addClient(Webclient('webclient', webclientProps));
@@ -149,8 +149,8 @@ Beispiel:
 import { requestNLUEvent } from '@botfabrik/engine-core';
 
 const webclientProps = {
-    getStartedAction: requestNLUEvent('WELCOME'),
-    showGeneralConditions: true,
+  getStartedAction: requestNLUEvent('WELCOME'),
+  showGeneralConditions: true,
 };
 
 bot.addClient(Webclient('webclient', webclientProps));
@@ -158,9 +158,9 @@ bot.addClient(Webclient('webclient', webclientProps));
 
 Die Bedingungen beinhalten drei Elemente:
 
--   Header: Titel der Bedingungen
--   Body: Eigentlicher Inhalt der Bedingungen
--   Accept-Condition-Note: Hinweis, dass man die Bedingungen akzeptiert, sobald man mit dem Bot kommuniziert.
+- Header: Titel der Bedingungen
+- Body: Eigentlicher Inhalt der Bedingungen
+- Accept-Condition-Note: Hinweis, dass man die Bedingungen akzeptiert, sobald man mit dem Bot kommuniziert.
 
 Diese Texte können auch Markdown beinhalten. Um die Standardtexte zu überschreiben, kann man den Übersetzungsmechanismus verwenden.
 
@@ -186,38 +186,38 @@ Beispiel (de.json)
 
 ```json
 {
-    "webclient": {
-        "message-input-label": "Nachricht eingeben ...",
-        "export-transcript": {
-            "email": {
-                "title": "Konversation per E-Mail versenden",
-                "description": "Geben Sie Ihre E-Mail-Adresse ein, um den Chatverlauf zu erhalten.",
-                "cancel": "Abbrechen",
-                "send": "Senden",
-                "placeholder": "Ihre E-Mail-Adresse",
-                "invalid": "Bitte gültige E-Mail-Adresse eingeben.",
-                "success": "Ich habe den Chatverlauf an Ihre E-Mail-Adresse gesendet."
-            },
-            "pdf": {
-                "title": "Konversation als PDF",
-                "description": "Laden Sie die Konversation als PDF herunter.",
-                "cancel": "Abbrechen",
-                "download": "Herunterladen"
-            }
-        },
-        "general-conditions": {
-            "header": "**Nutzungsbedingungen**", // Wird hier der Text leer gelassen, wird der Header inkl. Body nicht angezeigt.
-            "body": "Bitte berücksichtigen Sie die folgenden Punkte:\n\n - ...",
-            "accept-conditions-note": "Mit der Verwendung des Chats erklären Sie sich mit den Nutzungsbedingungen einverstanden." // Wird hier der Text leer gelassen, so wird dieses Element nicht angezeigt.
-        },
-        "problem-report": {
-            "action": {
-                "mark": "Als fehlerhaft markieren",
-                "unmark": "Markierung entfernen"
-            }
-        },
-        "powered-by": "Powered by [Bubble CMS](https://bubblecms.io)"
-    }
+  "webclient": {
+    "message-input-label": "Nachricht eingeben ...",
+    "export-transcript": {
+      "email": {
+        "title": "Konversation per E-Mail versenden",
+        "description": "Geben Sie Ihre E-Mail-Adresse ein, um den Chatverlauf zu erhalten.",
+        "cancel": "Abbrechen",
+        "send": "Senden",
+        "placeholder": "Ihre E-Mail-Adresse",
+        "invalid": "Bitte gültige E-Mail-Adresse eingeben.",
+        "success": "Ich habe den Chatverlauf an Ihre E-Mail-Adresse gesendet."
+      },
+      "pdf": {
+        "title": "Konversation als PDF",
+        "description": "Laden Sie die Konversation als PDF herunter.",
+        "cancel": "Abbrechen",
+        "download": "Herunterladen"
+      }
+    },
+    "general-conditions": {
+      "header": "**Nutzungsbedingungen**", // Wird hier der Text leer gelassen, wird der Header inkl. Body nicht angezeigt.
+      "body": "Bitte berücksichtigen Sie die folgenden Punkte:\n\n - ...",
+      "accept-conditions-note": "Mit der Verwendung des Chats erklären Sie sich mit den Nutzungsbedingungen einverstanden." // Wird hier der Text leer gelassen, so wird dieses Element nicht angezeigt.
+    },
+    "problem-report": {
+      "action": {
+        "mark": "Als fehlerhaft markieren",
+        "unmark": "Markierung entfernen"
+      }
+    },
+    "powered-by": "Powered by [Bubble CMS](https://bubblecms.io)"
+  }
 }
 ```
 
@@ -231,16 +231,16 @@ Verzeichnis 'public/\${name-meines-webclients}/' abgelegt werden. Auf gleiche Ar
 
 ```css
 :root {
-    --brand-primary-color: #008fd7;
-    --brand-secondary-color: white;
+  --brand-primary-color: #008fd7;
+  --brand-secondary-color: white;
 
-    --bot-bubble-background-color: white;
-    --bot-bubble-text-color: rgb(46, 46, 46);
+  --bot-bubble-background-color: white;
+  --bot-bubble-text-color: rgb(46, 46, 46);
 
-    --guest-bubble-background-color: #008fd7;
-    --guest-bubble-text-color: white;
+  --guest-bubble-background-color: #008fd7;
+  --guest-bubble-text-color: white;
 
-    --danger-color: #ee263d;
+  --danger-color: #ee263d;
 }
 ```