@botfabrik/engine-webclient 4.0.0-alpha.0

package/dist/requestSessionData.test.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const requestSessionData_1 = require("./requestSessionData");
+describe('request session id', () => {
+    beforeEach(() => {
+        jest.clearAllMocks();
+    });
+    const querystrings = {
+        sessionId: 'session-id',
+        accessToken: 'access-token',
+    };
+    it('when sessionId has been passed by query param but does not exists in db', async () => {
+        const findOne = jest.fn();
+        findOne.mockReturnValueOnce(undefined);
+        const sessionsCollection = {
+            findOne,
+        };
+        const { sessionId, isNew } = await requestSessionData_1.default(querystrings, sessionsCollection, 'test-bot', {});
+        expect(findOne).toHaveBeenCalledTimes(1);
+        expect(findOne).toHaveBeenCalledWith({ _id: 'session-id' }, { _id: 1, sessionInfo: 1 });
+        expect(sessionId).toBe('generated-uuid');
+        expect(isNew).toBe(true);
+    });
+    it('when sessionId has been passed by query param and exists in db', async () => {
+        const findOne = jest.fn();
+        findOne.mockReturnValueOnce({ _id: 'session-id' });
+        const sessionsCollection = {
+            findOne,
+        };
+        const { sessionId, isNew } = await requestSessionData_1.default(querystrings, sessionsCollection, 'test-bot', {});
+        expect(findOne).toHaveBeenCalledTimes(1);
+        expect(findOne).toHaveBeenCalledWith({ _id: 'session-id' }, { _id: 1, sessionInfo: 1 });
+        expect(sessionId).toBe('session-id');
+        expect(isNew).toBe(false);
+    });
+    it('when requestSessionRecordQuery has been passed as webclient property but no such session exists in db', async () => {
+        const findOne = jest.fn();
+        findOne.mockReturnValueOnce(undefined);
+        const sessionsCollection = {
+            findOne,
+        };
+        const requestSessionRecordQuery = jest.fn();
+        const props = {
+            requestSessionRecordQuery,
+        };
+        requestSessionRecordQuery.mockReturnValueOnce({ 'sessionInfo.user.id': 'hans@apptiva.ch' });
+        const { sessionId, isNew } = await requestSessionData_1.default(querystrings, sessionsCollection, 'test-bot', props);
+        expect(requestSessionRecordQuery).toHaveBeenCalledTimes(1);
+        expect(requestSessionRecordQuery).toHaveBeenCalledWith(querystrings);
+        expect(findOne).toHaveBeenCalledTimes(1);
+        expect(findOne).toHaveBeenCalledWith({
+            'sessionInfo.client.name': 'test-bot',
+            'sessionInfo.client.type': 'webclient',
+            'sessionInfo.user.id': 'hans@apptiva.ch',
+        }, { _id: 1, sessionInfo: 1 });
+        expect(sessionId).toBe('generated-uuid');
+        expect(isNew).toBe(true);
+    });
+    it('when requestSessionRecordQuery has been passed as webclient property and session exists in db', async () => {
+        const findOne = jest.fn();
+        findOne.mockReturnValueOnce({ _id: 'session-id' });
+        const sessionsCollection = {
+            findOne,
+        };
+        const requestSessionRecordQuery = jest.fn();
+        const props = {
+            requestSessionRecordQuery,
+        };
+        requestSessionRecordQuery.mockReturnValueOnce({ 'sessionInfo.user.id': 'hans@apptiva.ch' });
+        const { sessionId, isNew } = await requestSessionData_1.default(querystrings, sessionsCollection, 'test-bot', props);
+        expect(requestSessionRecordQuery).toHaveBeenCalledTimes(1);
+        expect(requestSessionRecordQuery).toHaveBeenCalledWith(querystrings);
+        expect(findOne).toHaveBeenCalledTimes(1);
+        expect(findOne).toHaveBeenCalledWith({
+            'sessionInfo.client.name': 'test-bot',
+            'sessionInfo.client.type': 'webclient',
+            'sessionInfo.user.id': 'hans@apptiva.ch',
+        }, { _id: 1, sessionInfo: 1 });
+        expect(sessionId).toBe('session-id');
+        expect(isNew).toBe(false);
+    });
+});
+//# sourceMappingURL=requestSessionData.test.js.map

package/dist/requestSessionData.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requestSessionData.test.js","sourceRoot":"","sources":["../src/requestSessionData.test.ts"],"names":[],"mappings":";;AAAA,6DAAsD;AAEtD,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAChC,UAAU,CAAC,GAAG,EAAE;QACZ,IAAI,CAAC,aAAa,EAAE,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG;QACjB,SAAS,EAAE,YAAY;QACvB,WAAW,EAAE,cAAc;KAC9B,CAAC;IAEF,EAAE,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;QACrF,MAAM,OAAO,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAC1B,OAAO,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;QACvC,MAAM,kBAAkB,GAAG;YACvB,OAAO;SACV,CAAC;QAEF,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,MAAM,4BAAkB,CAAC,YAAY,EAAE,kBAAkB,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;QAExG,MAAM,CAAC,OAAO,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACzC,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,EAAE,GAAG,EAAE,YAAY,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC,CAAC;QACxF,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACzC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC5E,MAAM,OAAO,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAC1B,OAAO,CAAC,mBAAmB,CAAC,EAAE,GAAG,EAAE,YAAY,EAAE,CAAC,CAAC;QACnD,MAAM,kBAAkB,GAAG;YACvB,OAAO;SACV,CAAC;QAEF,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,MAAM,4BAAkB,CAAC,YAAY,EAAE,kBAAkB,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;QAExG,MAAM,CAAC,OAAO,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACzC,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,EAAE,GAAG,EAAE,YAAY,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC,CAAC;QACxF,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACrC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uGAAuG,EAAE,KAAK,IAAI,EAAE;QACnH,MAAM,OAAO,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAC1B,OAAO,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;QACvC,MAAM,kBAAkB,GAAG;YACvB,OAAO;SACV,CAAC;QAEF,MAAM,yBAAyB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAC5C,MAAM,KAAK,GAAG;YACV,yBAAyB;SAC5B,CAAC;QACF,yBAAyB,CAAC,mBAAmB,CAAC,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAE5F,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,MAAM,4BAAkB,CAAC,YAAY,EAAE,kBAAkB,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;QAE3G,MAAM,CAAC,yBAAyB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC3D,MAAM,CAAC,yBAAyB,CAAC,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;QACrE,MAAM,CAAC,OAAO,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACzC,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAChC;YACI,yBAAyB,EAAE,UAAU;YACrC,yBAAyB,EAAE,WAAW;YACtC,qBAAqB,EAAE,iBAAiB;SAC3C,EACD,EAAE,GAAG,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAC7B,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACzC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+FAA+F,EAAE,KAAK,IAAI,EAAE;QAC3G,MAAM,OAAO,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAC1B,OAAO,CAAC,mBAAmB,CAAC,EAAE,GAAG,EAAE,YAAY,EAAE,CAAC,CAAC;QACnD,MAAM,kBAAkB,GAAG;YACvB,OAAO;SACV,CAAC;QAEF,MAAM,yBAAyB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAC5C,MAAM,KAAK,GAAG;YACV,yBAAyB;SAC5B,CAAC;QACF,yBAAyB,CAAC,mBAAmB,CAAC,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAE5F,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,MAAM,4BAAkB,CAAC,YAAY,EAAE,kBAAkB,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;QAE3G,MAAM,CAAC,yBAAyB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC3D,MAAM,CAAC,yBAAyB,CAAC,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;QACrE,MAAM,CAAC,OAAO,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACzC,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAChC;YACI,yBAAyB,EAAE,UAAU;YACrC,yBAAyB,EAAE,WAAW;YACtC,qBAAqB,EAAE,iBAAiB;SAC3C,EACD,EAAE,GAAG,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAC7B,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACrC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/speechToText.d.ts

@@ -0,0 +1,7 @@
+export interface SpeechToTextProps {
+    clientEmail: string;
+    privateKey: string;
+    contextPhrases?: any;
+}
+declare const speechToText: (speechProps: SpeechToTextProps, locale: string, speechBytes: any) => Promise<string>;
+export default speechToText;

package/dist/speechToText.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const speech_1 = require("@google-cloud/speech");
+const speechToText = (speechProps, locale, speechBytes) => {
+    return new Promise((resolve, reject) => {
+        const speechConfig = {
+            credentials: {
+                // eslint-disable-next-line @typescript-eslint/camelcase
+                private_key: speechProps.privateKey.replace(/\\n/g, '\n'),
+                // eslint-disable-next-line @typescript-eslint/camelcase
+                client_email: speechProps.clientEmail,
+            },
+        };
+        const client = new speech_1.SpeechClient(speechConfig);
+        // The audio file's encoding, sample rate in hertz, and BCP-47 language code
+        const audio = {
+            content: speechBytes,
+        };
+        const phrases = speechProps.contextPhrases && speechProps.contextPhrases[locale] ? speechProps.contextPhrases[locale] : [];
+        const config = {
+            encoding: 'LINEAR16',
+            sampleRateHertz: 16000,
+            languageCode: locale,
+            speechContexts: [
+                {
+                    phrases,
+                },
+            ],
+        };
+        const request = {
+            audio: audio,
+            config: config,
+        };
+        // Detects speech in the audio file
+        client
+            .recognize(request)
+            .then((data) => {
+            const response = data[0];
+            const transcription = response.results.map((result) => result.alternatives[0].transcript).join('\n');
+            resolve(transcription);
+        })
+            .catch(reject);
+    });
+};
+exports.default = speechToText;
+//# sourceMappingURL=speechToText.js.map

package/dist/speechToText.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"speechToText.js","sourceRoot":"","sources":["../src/speechToText.ts"],"names":[],"mappings":";;AAAA,iDAAoD;AAQpD,MAAM,YAAY,GAAG,CAAC,WAA8B,EAAE,MAAc,EAAE,WAAW,EAAmB,EAAE;IAClG,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACnC,MAAM,YAAY,GAAG;YACjB,WAAW,EAAE;gBACT,wDAAwD;gBACxD,WAAW,EAAE,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC;gBACzD,wDAAwD;gBACxD,YAAY,EAAE,WAAW,CAAC,WAAW;aACxC;SACJ,CAAC;QAEF,MAAM,MAAM,GAAG,IAAI,qBAAY,CAAC,YAAY,CAAC,CAAC;QAE9C,4EAA4E;QAC5E,MAAM,KAAK,GAAG;YACV,OAAO,EAAE,WAAW;SACvB,CAAC;QACF,MAAM,OAAO,GACT,WAAW,CAAC,cAAc,IAAI,WAAW,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/G,MAAM,MAAM,GAAG;YACX,QAAQ,EAAE,UAAU;YACpB,eAAe,EAAE,KAAK;YACtB,YAAY,EAAE,MAAM;YACpB,cAAc,EAAE;gBACZ;oBACI,OAAO;iBACV;aACJ;SACJ,CAAC;QAEF,MAAM,OAAO,GAAG;YACZ,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACV,CAAC;QAET,mCAAmC;QACnC,MAAM;aACD,SAAS,CAAC,OAAO,CAAC;aAClB,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YACX,MAAM,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YACzB,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACrG,OAAO,CAAC,aAAa,CAAC,CAAC;QAC3B,CAAC,CAAC;aACD,KAAK,CAAC,MAAM,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,kBAAe,YAAY,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,7 @@
+export declare type SessionInfoClientPayload = {
+    headers: any;
+    querystrings: any;
+    ip: string;
+};
+export declare type SessionInfoUserPayload = {};
+export declare type WebclientMiddlewareState = {};

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/dist/views/index.d.ts

@@ -0,0 +1,2 @@
+declare const index: (server: string, scriptUrl: string) => string;
+export default index;

package/dist/views/index.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index = (server, scriptUrl) => `<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="UTF-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+        <meta http-equiv="X-UA-Compatible" content="ie=edge" />
+        <link href="https://fonts.googleapis.com/css?family=Open+Sans&display=swap" rel="stylesheet" />
+        <title>Botfabrik Chatbot-Webclient</title>
+        <style>
+            html {
+                font-family: 'Open Sans', sans-serif;
+                height: 100%;
+            }
+            body {
+                display: grid;
+                height: 100%;
+                grid-template-rows: auto 1fr;
+                margin: 0;
+            }
+            header {
+                color: white;
+                background-color: #1ba7e2;
+                padding: 3em 0;
+            }
+            main {
+                display: flex;
+                flex-direction: column;
+                padding: 4em 0;
+                min-width: 0; // needed for overflow on pre to work
+            }
+            a.button {
+                display: inline-block;
+                font-weight: bold;
+                color: #1ba7e2;
+                border: 2px solid #1ba7e2;
+                border-radius: 0.4em;
+                padding: 0.8em 1.6em;
+                margin: 1em 1em 0 0;
+                text-decoration: none;
+                white-space: nowrap;
+            }
+            pre {
+                padding: 1em;
+                border: 1px solid #aaa;
+                border-radius: 0.4em;
+                overflow-x: auto;
+            }
+            .container {
+                max-width: 1280px;
+                margin-left: auto;
+                margin-right: auto;
+                padding: 1.5em;
+            }
+        </style>
+    </head>
+    <body>
+        <header>
+            <div class="container">
+                <h1>Botfabrik Chatbot-Webclient</h1>
+            </div>
+        </header>
+        <main>
+            <section id="snippet-area" style="flex: 1 1 auto;">
+                <div class="container">
+                    <h2>Chatbot einbinden</h2>
+                    <h3>Snippet</h3>
+                    <p>
+                        Der Chatbot kann mit dem folgenden Snippet eingebettet werden. Am besten wird das Snippet zu
+                        unterst im Body hinzugefügt.
+                    </p>
+                    <pre><code>&lt;script id=&quot;chatbot&quot; data-server=&quot;${server}&quot; defer src=&quot;${scriptUrl}&quot;&gt;&lt;/script&gt;</code></pre>
+
+                    <h3>Bookmarklet (nur zum Testen)</h3>
+                    <p>Um die Integration schnell zu testen, kann das folgende Bookmarklet verwendet werden.</p>
+                    <ol>
+                        <li>
+                            Bookmarklet zu den Browser-Favoriten hinzufügen.
+                        </li>
+                        <li>Die gewünschte Seite im Browser öffnen.</li>
+                        <li>Bookmarklet in den Favoriten anklicken.</li>
+                    </ol>
+                    <a
+                        id="bookmarklet"
+                        href="javascript:(function (){var script=document.createElement('script');script.id='chatbot';script.src='${scriptUrl}';document.head.appendChild(script);}());"
+                        >Chatbot Bookmarklet</a
+                    >
+                </div>
+            </section>
+            <section>
+                <div class="container">
+                    <a class="button" href="${server}">Vollbild Chatbot</a>
+                </div>
+            </section>
+        </main>
+        <script id="chatbot" data-server="${server}" defer src="${scriptUrl}"></script>
+    </body>
+</html>
+`;
+exports.default = index;
+//# sourceMappingURL=index.js.map

package/dist/views/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/views/index.ts"],"names":[],"mappings":";;AAAA,MAAM,KAAK,GAAG,CAAC,MAAc,EAAE,SAAiB,EAAU,EAAE,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qFAsEwB,MAAM,0BAA0B,SAAS;;;;;;;;;;;;;oIAaM,SAAS;;;;;;;8CAO/F,MAAM;;;;4CAIR,MAAM,gBAAgB,SAAS;;;CAG1E,CAAC;AACF,kBAAe,KAAK,CAAC"}

package/package.json

@@ -0,0 +1,36 @@
+{
+    "name": "@botfabrik/engine-webclient",
+    "version": "4.0.0-alpha.0",
+    "description": "Webclient for Botfabriks Bot Engine",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "build": "npm run clean && npm run build:client && npm run build:server && npm run copy:client",
+        "build:script-tag": "cd script-tag && npm run build && cd ..",
+        "build:client": "cd client && npm run build && cd ..",
+        "build:server": "tsc",
+        "copy:script-tag": "copyfiles -u 2 ./script-tag/dist/**/*.* ./dist/embed && copyfiles -u 2 ./script-tag/public/**/*.* ./dist/embed",
+        "copy:client": "copyfiles -u 2 ./client/build/**/*.* ./dist/client",
+        "clean": "rimraf ./dist",
+        "test": "jest --verbose",
+        "test:watch": "jest --watch",
+        "prepublishOnly": "npm run build"
+    },
+    "devDependencies": {
+        "@types/accept-language-parser": "^1.5.1",
+        "@types/express": "^4.17.6",
+        "@types/socket.io": "^2.1.6",
+        "copyfiles": "^2.2.0",
+        "rimraf": "^3.0.2",
+        "typescript": "^3.9.5"
+    },
+    "dependencies": {
+        "@botfabrik/botfabrik-utils": "^3.2.15",
+        "@botfabrik/engine-domain": "^4.0.0-alpha.0",
+        "@google-cloud/speech": "^3.6.0",
+        "accept-language-parser": "^1.5.0",
+        "express": "^4.17.1",
+        "uuid": "^8.1.0"
+    },
+    "gitHead": "c7c5dd361f197112b9063604c59aca4ec9b8bc28"
+}