@vraksha/bottender-dialogflow 1.7.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017-present Yoctol (github.com/Yoctol/bottender)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,80 @@
+# @vraksha/bottender-dialogflow
+
+[Dialogflow](https://dialogflow.com/) integration for Bottender.
+
+## Installation
+
+You can install it with npm:
+
+```sh
+npm install @vraksha/bottender-dialogflow
+```
+
+or Yarn:
+
+```sh
+yarn add @vraksha/bottender-dialogflow
+```
+
+## Usage
+
+```js
+const { chain } = require('bottender');
+const dialogflow = require('@vraksha/bottender-dialogflow');
+
+async function SayHello(context) {
+  await context.sendText('Hello!');
+}
+
+async function Unknown(context) {
+  await context.sendText('Sorry, I don’t know what you say.');
+}
+
+const Dialogflow = dialogflow({
+  projectId: process.env.GOOGLE_APPLICATION_PROJECT_ID,
+  actions: {
+    greeting: SayHello,
+  },
+});
+
+module.exports = async function App() {
+  return chain([
+    Dialogflow, //
+    Unknown,
+  ]);
+};
+```
+
+## Reference
+
+### projectId
+
+The ID of your Dialogflow Project.
+
+Type: `string`.
+Required.
+
+### languageCode
+
+The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.
+
+Type: `string`.
+Required.
+
+### actions
+
+Actions to be executed when the event matches corresponding intent.
+
+Type: `Record<string, Action>`.
+Required.
+
+### timeZone
+
+The time zone of this conversational query from the time zone database, e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in agent settings is used.
+
+Type: `string`.
+Optional.
+
+## License
+
+MIT © [Yoctol](https://github.com/Yoctol/bottender)

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import { protos } from '@google-cloud/dialogflow';
+import { Action, Context } from '@vraksha/bottender';
+declare const _default: ({ projectId, languageCode, actions, timeZone, }: {
+    projectId: string;
+    languageCode: string;
+    actions: Record<string, Action<Context<any, any>, protos.google.cloud.dialogflow.v2.IQueryResult, {}>>;
+    timeZone?: string | undefined;
+}) => Action<Context>;
+export = _default;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAsB,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAEjE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAa,MAAM,oBAAoB,CAAC;;eA2DnD,MAAM;kBACH,MAAM;;;MAMlB,OAAO,OAAO,CAAC;AAbnB,kBA4FE"}

package/dist/index.js

@@ -0,0 +1,93 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const dialogflow_1 = __importDefault(require("@google-cloud/dialogflow"));
+const invariant_1 = __importDefault(require("invariant"));
+const bottender_1 = require("@vraksha/bottender");
+function getFulfillments(messages) {
+    if (!messages) {
+        return [];
+    }
+    return messages
+        .filter((message) => message.platform === 'PLATFORM_UNSPECIFIED')
+        .map((message) => message.text)
+        .filter((text) => Boolean(text))
+        .map((text) => text.text)
+        .filter((text) => Boolean(text))
+        .map((texts) => {
+        const index = Math.floor(Math.random() * texts.length);
+        return texts[index];
+    });
+}
+function getTargetAction(actions, intent) {
+    if (intent.name && actions[intent.name]) {
+        return actions[intent.name];
+    }
+    if (intent.displayName && actions[intent.displayName]) {
+        return actions[intent.displayName];
+    }
+}
+module.exports = function dialogflow({ projectId, languageCode = 'en', actions = {}, timeZone, }) {
+    (0, invariant_1.default)(typeof projectId === 'string' && projectId.length > 0, 'dialogflow: `projectId` is a required parameter.');
+    const credentials = process.env.GOOGLE_APPLICATION_CREDENTIALS;
+    (0, invariant_1.default)(typeof credentials === 'string' && credentials.length > 0, 'dialogflow: `GOOGLE_APPLICATION_CREDENTIALS` is required. Please make sure you have filled it correctly in `.env` file.');
+    const sessionsClient = new dialogflow_1.default.SessionsClient();
+    return function Dialogflow(context, { next }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!context.event.isText || !context.session) {
+                return next;
+            }
+            const sessionPath = sessionsClient.projectAgentSessionPath(projectId, context.session.id);
+            const request = {
+                session: sessionPath,
+                queryInput: {
+                    text: {
+                        text: context.event.text,
+                        languageCode,
+                    },
+                },
+                queryParams: {
+                    timeZone,
+                },
+            };
+            const [response] = yield sessionsClient.detectIntent(request);
+            const queryResult = response.queryResult;
+            if (!queryResult) {
+                context.setAsNotHandled();
+                return next;
+            }
+            const { intent, fulfillmentMessages } = queryResult;
+            if (!intent) {
+                context.setAsNotHandled();
+                return next;
+            }
+            if (intent.displayName) {
+                context.setIntent(intent.displayName);
+            }
+            context.setAsHandled();
+            const TargetAction = getTargetAction(actions, intent);
+            if (TargetAction) {
+                return (0, bottender_1.withProps)(TargetAction, Object.assign({}, queryResult));
+            }
+            const fulfillments = getFulfillments(fulfillmentMessages);
+            if (fulfillments.length > 0) {
+                for (const fulfillment of fulfillments) {
+                    yield context.sendText(fulfillment);
+                }
+                return;
+            }
+            return next;
+        });
+    };
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,0EAAiE;AACjE,0DAAkC;AAClC,kDAAgE;AAEhE,SAAS,eAAe,CACtB,QAAqE;IAErE,IAAI,CAAC,QAAQ,EAAE;QACb,OAAO,EAAE,CAAC;KACX;IAED,OAAO,QAAQ;SACZ,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,sBAAsB,CAAC;SAChE,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;SAC9B,MAAM,CACL,CAAC,IAAI,EAAkE,EAAE,CACvE,OAAO,CAAC,IAAI,CAAC,CAChB;SACA,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;SACxB,MAAM,CAAC,CAAC,IAAI,EAAoB,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SACjD,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACb,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QACvD,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC;IACtB,CAAC,CAAC,CAAC;AACP,CAAC;AAED,SAAS,eAAe,CACtB,OAGC,EACD,MAAiD;IAEjD,IAAI,MAAM,CAAC,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;QACvC,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;KAC7B;IAED,IAAI,MAAM,CAAC,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE;QACrD,OAAO,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;KACpC;AACH,CAAC;AAeD,iBAAS,SAAS,UAAU,CAAC,EAC3B,SAAS,EACT,YAAY,GAAG,IAAI,EACnB,OAAO,GAAG,EAAE,EACZ,QAAQ,GAST;IACC,IAAA,mBAAS,EACP,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EACrD,kDAAkD,CACnD,CAAC;IAEF,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC;IAC/D,IAAA,mBAAS,EACP,OAAO,WAAW,KAAK,QAAQ,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EACzD,yHAAyH,CAC1H,CAAC;IAEF,MAAM,cAAc,GAAG,IAAI,oBAAa,CAAC,cAAc,EAAE,CAAC;IAE1D,OAAO,SAAe,UAAU,CAC9B,OAAgB,EAChB,EAAE,IAAI,EAA8B;;YAEpC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;gBAC7C,OAAO,IAAI,CAAC;aACb;YAED,MAAM,WAAW,GAAG,cAAc,CAAC,uBAAuB,CACxD,SAAS,EACT,OAAO,CAAC,OAAO,CAAC,EAAE,CACnB,CAAC;YAEF,MAAM,OAAO,GAAG;gBACd,OAAO,EAAE,WAAW;gBACpB,UAAU,EAAE;oBACV,IAAI,EAAE;wBACJ,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI;wBACxB,YAAY;qBACb;iBACF;gBACD,WAAW,EAAE;oBACX,QAAQ;iBACT;aACF,CAAC;YAGF,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,cAAc,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;YAC9D,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;YAEzC,IAAI,CAAC,WAAW,EAAE;gBAChB,OAAO,CAAC,eAAe,EAAE,CAAC;gBAC1B,OAAO,IAAI,CAAC;aACb;YAED,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,GAAG,WAAW,CAAC;YAEpD,IAAI,CAAC,MAAM,EAAE;gBACX,OAAO,CAAC,eAAe,EAAE,CAAC;gBAC1B,OAAO,IAAI,CAAC;aACb;YAED,IAAI,MAAM,CAAC,WAAW,EAAE;gBACtB,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;aACvC;YACD,OAAO,CAAC,YAAY,EAAE,CAAC;YAGvB,MAAM,YAAY,GAAG,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YACtD,IAAI,YAAY,EAAE;gBAChB,OAAO,IAAA,qBAAS,EAAC,YAAY,oBAAO,WAAW,EAAG,CAAC;aACpD;YAGD,MAAM,YAAY,GAAG,eAAe,CAAC,mBAAmB,CAAC,CAAC;YAC1D,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC3B,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;oBAEtC,MAAM,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;iBACrC;gBACD,OAAO;aACR;YAED,OAAO,IAAI,CAAC;QACd,CAAC;KAAA,CAAC;AACJ,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@vraksha/bottender-dialogflow",
+  "version": "1.7.0",
+  "description": "Dialogflow integration for Bottender.",
+  "license": "MIT",
+  "homepage": "https://bottender.js.org/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Yoctol/bottender.git"
+  },
+  "main": "dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "types": "dist/index.d.ts",
+  "dependencies": {
+    "@google-cloud/dialogflow": "^4.4.0",
+    "invariant": "^2.2.4"
+  },
+  "peerDependencies": {
+    "@vraksha/bottender": ">= 1.2.0-0"
+  },
+  "devDependencies": {
+    "@vraksha/bottender": "1.7.0"
+  },
+  "keywords": [
+    "bot",
+    "bottender",
+    "chatbot",
+    "dialogflow",
+    "language",
+    "messaging",
+    "nlu",
+    "understanding"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}