@botfabrik/engine-webclient 4.121.5 → 4.122.0

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 (9) hide show
  1. package/README.md +13 -4
  2. package/dist/client/assets/{index-Dwmr7EiL.js → index-u0WiQbPl.js} +24 -24
  3. package/dist/client/assets/{index-Dwmr7EiL.js.map → index-u0WiQbPl.js.map} +1 -1
  4. package/dist/client/index.html +1 -1
  5. package/dist/createSessionInfo.js +25 -10
  6. package/dist/createSessionInfo.test.js +3 -2
  7. package/dist/embed/bundle.js +1 -1
  8. package/dist/types.d.ts +26 -3
  9. package/package.json +4 -4
package/README.md CHANGED
@@ -135,18 +135,27 @@ Beispiel
135
135
 
136
136
  Eine Liste von projektspezifischen Einträgen, die im Chat-Menü angezeigt werden sollen.
137
137
 
138
- ### requestUserInfos (optional)
138
+ ### enrichUserInfo (optional)
139
139
 
140
140
  Diese Funktion wird beim Erzeugen eines neuen Session Records aufgerufen. Man hat damit die Möglichkeit, die Session Daten unter `session.getSessionInfo().user` projektspezifisch anzupassen.
141
141
 
142
- Die Funktion erhält als Parameter sämtliche Querystrings in Form eines JSON Objektes. Als Resultat wird wiederum ein JSON Objekt erwartet. Alle Werte unter `session.getSessionInfo().user` werden damit überschrieben.
142
+ Die Funktion erhält als Parameter ein Objekt mit folgenden Eigenschaften:
143
+
144
+ - `user` – Das aktuelle Session-User-Objekt, aufgebaut aus Authentifizierung und Query-Parametern.
145
+ - `querystrings` – Die geparsten Query-Parameter der Client-URL.
146
+ - `headers` – Die eingehenden HTTP-Request-Header.
147
+ - `ip` – Die IP-Adresse des Clients (oder `undefined`).
148
+
149
+ Als Resultat wird ein partielles User-Info-Objekt erwartet. Dessen Eigenschaften werden in die bestehenden User-Daten eingemergt.
143
150
 
144
151
  Beispiel:
145
152
 
146
153
  ```typescript
147
- export default async (querystrings: any): Promise<any> => {
154
+ const enrichUserInfo: EnrichUserInfo = async ({ querystrings }) => {
148
155
  const accessToken = querystrings.accessToken;
149
- const userProfile: UserProfile = await fetchUserProfile(accessToken);
156
+ const userProfile: UserProfile = await fetchUserProfile(
157
+ accessToken as string
158
+ );
150
159
 
151
160
  return {
152
161
  id: userProfile.username + '@' + userProfile.domain,