@xapp/stentor-gbm 1.40.336

package/lib/Translators/TranslateRequest/helpers.js

@@ -0,0 +1,2 @@
+/*! Copyright (c) 2022, XAPPmedia */
+//# sourceMappingURL=helpers.js.map

package/lib/Translators/TranslateRequest/helpers.js.map

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

package/lib/Translators/TranslateRequest/index.d.ts

@@ -0,0 +1,7 @@
+/*! Copyright (c) 2022, XAPPmedia */
+import { Translator } from "@xapp/patterns/lib";
+import { Request } from "stentor-models";
+import { UserMessage } from "../../models";
+export declare class TranslateRequest extends Translator<UserMessage, Request> {
+    translate(requestBody: UserMessage): Request;
+}

package/lib/Translators/TranslateRequest/index.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TranslateRequest = void 0;
+/*! Copyright (c) 2022, XAPPmedia */
+const lib_1 = require("@xapp/patterns/lib");
+const stentor_logger_1 = require("stentor-logger");
+const Constants_1 = require("../../Constants");
+class TranslateRequest extends lib_1.Translator {
+    translate(requestBody) {
+        let rawQuery;
+        if (requestBody.message !== undefined && requestBody.message.text !== undefined) {
+            rawQuery = requestBody.message.text;
+        }
+        else if (requestBody.suggestionResponse !== undefined) {
+            rawQuery = requestBody.suggestionResponse.postbackData;
+        }
+        else if (requestBody.userStatus !== undefined) {
+            // TODO later
+            if (requestBody.userStatus.requestedLiveAgent !== undefined) {
+                (0, stentor_logger_1.log)().info("User requested transfer to live agent");
+            }
+        }
+        // These are generated by the external hook
+        const isNewSession = requestBody._chat.isNewSession;
+        const userId = requestBody._chat.userId;
+        const sessionId = requestBody._chat.sessionId;
+        (0, stentor_logger_1.log)().info(`GBM: session id - ${sessionId} - user id: ${userId} - new session: ${isNewSession}`);
+        let botRequest;
+        if (isNewSession) {
+            botRequest = {
+                type: "LAUNCH_REQUEST",
+                rawQuery,
+                sessionId,
+                userId,
+                isNewSession,
+                intentId: "LaunchRequest",
+                platform: Constants_1.GOOGLE_BUSINESS_MESSAGES_PLATFORM
+            };
+        }
+        else {
+            botRequest = {
+                type: "INTENT_REQUEST",
+                rawQuery,
+                sessionId,
+                userId,
+                isNewSession,
+                intentId: "NLU_RESULT_PLACEHOLDER",
+                platform: Constants_1.GOOGLE_BUSINESS_MESSAGES_PLATFORM
+            };
+        }
+        botRequest.channel = Constants_1.GOOGLE_BUSINESS_MESSAGES_CHANNEL;
+        botRequest.locale = "en-US"; // no actual locale in the payload
+        return botRequest;
+    }
+}
+exports.TranslateRequest = TranslateRequest;
+//# sourceMappingURL=index.js.map

package/lib/Translators/TranslateRequest/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Translators/TranslateRequest/index.ts"],"names":[],"mappings":";;;AAAC,oCAAoC;AACrC,4CAAgD;AAQhD,mDAAqC;AAErC,+CAAsG;AAGrG,MAAa,gBAAiB,SAAQ,gBAAgC;IAC5D,SAAS,CAAC,WAAwB;QACrC,IAAI,QAAgB,CAAC;QAErB,IAAI,WAAW,CAAC,OAAO,KAAK,SAAS,IAAI,WAAW,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE;YAC7E,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC;SACvC;aAAM,IAAI,WAAW,CAAC,kBAAkB,KAAK,SAAS,EAAE;YACrD,QAAQ,GAAG,WAAW,CAAC,kBAAkB,CAAC,YAAY,CAAC;SAC1D;aAAM,IAAI,WAAW,CAAC,UAAU,KAAK,SAAS,EAAE;YAC7C,aAAa;YACb,IAAI,WAAW,CAAC,UAAU,CAAC,kBAAkB,KAAK,SAAS,EAAE;gBACzD,IAAA,oBAAG,GAAE,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;aACvD;SACJ;QAED,2CAA2C;QAC3C,MAAM,YAAY,GAAG,WAAW,CAAC,KAAK,CAAC,YAAY,CAAC;QACpD,MAAM,MAAM,GAAW,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC;QAChD,MAAM,SAAS,GAAW,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC;QAEtD,IAAA,oBAAG,GAAE,CAAC,IAAI,CAAC,qBAAqB,SAAS,eAAe,MAAM,mBAAmB,YAAY,EAAE,CAAC,CAAC;QAEjG,IAAI,UAAmF,CAAC;QAExF,IAAI,YAAY,EAAE;YACd,UAAU,GAAG;gBACT,IAAI,EAAE,gBAAgB;gBACtB,QAAQ;gBACR,SAAS;gBACT,MAAM;gBACN,YAAY;gBACZ,QAAQ,EAAE,eAAe;gBACzB,QAAQ,EAAE,6CAAiC;aAC9C,CAAC;SACL;aAAM;YACH,UAAU,GAAG;gBACT,IAAI,EAAE,gBAAgB;gBACtB,QAAQ;gBACR,SAAS;gBACT,MAAM;gBACN,YAAY;gBACZ,QAAQ,EAAE,wBAAwB;gBAClC,QAAQ,EAAE,6CAAiC;aAC9C,CAAC;SACL;QAED,UAAU,CAAC,OAAO,GAAG,4CAAgC,CAAC;QACtD,UAAU,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC,kCAAkC;QAE/D,OAAO,UAAU,CAAC;IACtB,CAAC;CACJ;AAnDA,4CAmDA"}

package/lib/Translators/TranslateResponse/helpers.d.ts

@@ -0,0 +1 @@
+/*! Copyright (c) 2022, XAPPmedia */

package/lib/Translators/TranslateResponse/helpers.js

@@ -0,0 +1,2 @@
+/*! Copyright (c) 2022, XAPPmedia */
+//# sourceMappingURL=helpers.js.map

package/lib/Translators/TranslateResponse/helpers.js.map

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

package/lib/Translators/TranslateResponse/index.d.ts

@@ -0,0 +1,11 @@
+/*! Copyright (c) 2022, XAPPmedia */
+import { Translator } from "@xapp/patterns/lib";
+import { RequestResponse } from "stentor-models";
+import { AgentMessage } from "../../models";
+import { GbmChannelProps } from "../../Channel";
+export declare class TranslateResponse extends Translator<RequestResponse, AgentMessage> {
+    protected readonly props?: GbmChannelProps;
+    constructor(props?: GbmChannelProps);
+    translate(requestResponse: RequestResponse): AgentMessage;
+    private getRepresentative;
+}

package/lib/Translators/TranslateResponse/index.js

@@ -0,0 +1,205 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TranslateResponse = void 0;
+/*! Copyright (c) 2022, XAPPmedia */
+const lib_1 = require("@xapp/patterns/lib");
+const stentor_response_1 = require("stentor-response");
+const stentor_logger_1 = require("stentor-logger");
+const uuid_1 = require("uuid");
+const models_1 = require("../../models");
+class TranslateResponse extends lib_1.Translator {
+    constructor(props) {
+        super();
+        this.props = props;
+    }
+    translate(requestResponse) {
+        let gbmResponse;
+        const botResponse = requestResponse.response;
+        (0, stentor_logger_1.log)().debug(`GBM: BOT SAYS ${JSON.stringify(botResponse)}`);
+        if (botResponse) {
+            let text;
+            let card;
+            let list;
+            const outputSpeech = botResponse.outputSpeech;
+            if (outputSpeech) {
+                text = outputSpeech.displayText;
+            }
+            if (botResponse.displays && botResponse.displays.length > 0) {
+                const display = botResponse.displays[0];
+                if ((0, stentor_response_1.isCard)(display)) {
+                    card = display;
+                }
+                else if ((0, stentor_response_1.isList)(display)) {
+                    list = display;
+                }
+            }
+            const messageId = (0, uuid_1.v4)();
+            const representative = this.getRepresentative();
+            const suggestions = convertSuggestions(outputSpeech.suggestions);
+            if (text) {
+                gbmResponse = {
+                    messageId,
+                    representative,
+                    text,
+                    suggestions
+                };
+            }
+            if (card) {
+                const imageUrl = card.smallImageUrl || card.largeImageUrl;
+                gbmResponse = {
+                    messageId,
+                    representative,
+                    richCard: {
+                        standaloneCard: {
+                            cardContent: {
+                                title: card.title,
+                                description: card.content,
+                                media: imageUrl ? {
+                                    height: models_1.Height.MEDIUM,
+                                    contentInfo: {
+                                        fileUrl: imageUrl,
+                                        forceRefresh: false
+                                    }
+                                } : undefined,
+                                suggestions
+                            }
+                        }
+                    }
+                };
+            }
+            if (list) {
+                gbmResponse = {
+                    messageId,
+                    representative,
+                    richCard: {
+                        carouselCard: convertList(list)
+                    }
+                };
+            }
+        }
+        else {
+            gbmResponse = {
+                messageId: (0, uuid_1.v4)(),
+                representative: this.getRepresentative(),
+                text: "Something went wrong. The gremlins were fed after midnight. Try later!"
+            };
+        }
+        return gbmResponse;
+    }
+    getRepresentative() {
+        return {
+            representativeType: models_1.RepresentativeType.BOT,
+            displayName: this.props.botAvatarName,
+            avatarImage: this.props.botAvatarImageUrl
+        };
+    }
+}
+exports.TranslateResponse = TranslateResponse;
+/**
+ * Convert suggestions
+ *
+ * @param suggestions
+ */
+function convertSuggestions(suggestions) {
+    if (!suggestions || suggestions.length === 0) {
+        return undefined;
+    }
+    const gbmSuggestions = [];
+    for (const suggestion of suggestions) {
+        if (typeof suggestion === "string") {
+            gbmSuggestions.push({
+                reply: {
+                    text: suggestion,
+                    postbackData: suggestion
+                }
+            });
+        }
+        else if (suggestion.title && suggestion.url) {
+            const url = suggestion.url;
+            // Phone dial is separate - check the url of the action (<a href="tel:123-456-7890">Call</a>)
+            if (url.toLowerCase().startsWith("tel:")) {
+                const phoneNumber = url.substring(4);
+                gbmSuggestions.push({
+                    action: {
+                        text: suggestion.title,
+                        postbackData: suggestion.title,
+                        dialAction: {
+                            phoneNumber
+                        }
+                    },
+                });
+            }
+            else {
+                gbmSuggestions.push({
+                    action: {
+                        text: suggestion.title,
+                        postbackData: suggestion.title,
+                        openUrlAction: {
+                            url
+                        }
+                    }
+                });
+            }
+        }
+        else if (suggestion.title) {
+            gbmSuggestions.push({
+                reply: {
+                    text: suggestion.title,
+                    postbackData: suggestion.title
+                }
+            });
+        }
+    }
+    return gbmSuggestions;
+}
+/**
+ * Convert stentor buttons to chips
+ *
+ * @param buttons
+ */
+function convertButtonSuggestions(buttons) {
+    if (!buttons || buttons.length === 0) {
+        return undefined;
+    }
+    const gbmSuggestions = [];
+    for (const button of buttons) {
+        if (button.title) {
+            gbmSuggestions.push({
+                action: {
+                    text: button.title,
+                    postbackData: button.title
+                }
+            });
+        }
+    }
+    return gbmSuggestions;
+}
+/**
+ * Create individual cards for the carousel
+ *
+ * @param list
+ */
+function convertList(list) {
+    var _a;
+    const cardContents = [];
+    for (const listItem of list.items) {
+        const imageUrl = (_a = listItem.image) === null || _a === void 0 ? void 0 : _a.url;
+        cardContents.push({
+            title: listItem.title,
+            description: listItem.description,
+            suggestions: convertButtonSuggestions(listItem.buttons),
+            media: imageUrl ? {
+                height: models_1.Height.MEDIUM,
+                contentInfo: {
+                    fileUrl: imageUrl,
+                    forceRefresh: false
+                }
+            } : undefined
+        });
+    }
+    return {
+        cardWidth: models_1.CardWidth.MEDIUM,
+        cardContents: cardContents,
+    };
+}
+//# sourceMappingURL=index.js.map

package/lib/Translators/TranslateResponse/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Translators/TranslateResponse/index.ts"],"names":[],"mappings":";;;AAAA,oCAAoC;AACpC,4CAAgD;AAGhD,uDAAkD;AAClD,mDAAqC;AAErC,+BAAkC;AAElC,yCAQsB;AAGtB,MAAa,iBAAkB,SAAQ,gBAAyC;IAG5E,YAAY,KAAuB;QAC/B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACvB,CAAC;IAEM,SAAS,CAAC,eAAgC;QAC7C,IAAI,WAAyB,CAAC;QAE9B,MAAM,WAAW,GAAG,eAAe,CAAC,QAAQ,CAAC;QAE7C,IAAA,oBAAG,GAAE,CAAC,KAAK,CAAC,iBAAiB,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAE5D,IAAI,WAAW,EAAE;YACb,IAAI,IAAI,CAAC;YACT,IAAI,IAAI,CAAC;YACT,IAAI,IAAI,CAAC;YAET,MAAM,YAAY,GAAG,WAAW,CAAC,YAA8B,CAAC;YAEhE,IAAI,YAAY,EAAE;gBACd,IAAI,GAAG,YAAY,CAAC,WAAW,CAAC;aACnC;YAED,IAAI,WAAW,CAAC,QAAQ,IAAI,WAAW,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;gBACzD,MAAM,OAAO,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;gBACxC,IAAI,IAAA,yBAAM,EAAC,OAAO,CAAC,EAAE;oBACjB,IAAI,GAAG,OAAO,CAAC;iBAClB;qBAAM,IAAI,IAAA,yBAAM,EAAC,OAAO,CAAC,EAAE;oBACxB,IAAI,GAAG,OAAO,CAAC;iBAClB;aACJ;YAED,MAAM,SAAS,GAAG,IAAA,SAAM,GAAE,CAAC;YAC3B,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAChD,MAAM,WAAW,GAAG,kBAAkB,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;YAEjE,IAAI,IAAI,EAAE;gBACN,WAAW,GAAG;oBACV,SAAS;oBACT,cAAc;oBACd,IAAI;oBACJ,WAAW;iBACd,CAAC;aACL;YAED,IAAI,IAAI,EAAE;gBACN,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC;gBAE1D,WAAW,GAAG;oBACV,SAAS;oBACT,cAAc;oBACd,QAAQ,EAAG;wBACP,cAAc,EAAE;4BACZ,WAAW,EAAE;gCACT,KAAK,EAAE,IAAI,CAAC,KAAK;gCACjB,WAAW,EAAE,IAAI,CAAC,OAAO;gCACzB,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;oCACd,MAAM,EAAE,eAAM,CAAC,MAAM;oCACrB,WAAW,EAAE;wCACT,OAAO,EAAE,QAAQ;wCACjB,YAAY,EAAE,KAAK;qCACtB;iCACJ,CAAC,CAAC,CAAC,SAAS;gCACb,WAAW;6BACd;yBACJ;qBACJ;iBACJ,CAAC;aACL;YAED,IAAI,IAAI,EAAE;gBACN,WAAW,GAAG;oBACV,SAAS;oBACT,cAAc;oBACd,QAAQ,EAAE;wBACN,YAAY,EAAE,WAAW,CAAC,IAAI,CAAC;qBAClC;iBACJ,CAAC;aACL;SAEJ;aAAM;YACH,WAAW,GAAG;gBACV,SAAS,EAAE,IAAA,SAAM,GAAE;gBACnB,cAAc,EAAE,IAAI,CAAC,iBAAiB,EAAE;gBACxC,IAAI,EAAE,wEAAwE;aACjF,CAAC;SACL;QAED,OAAO,WAAW,CAAC;IACvB,CAAC;IAEO,iBAAiB;QACrB,OAAO;YACH,kBAAkB,EAAE,2BAAkB,CAAC,GAAG;YAC1C,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,aAAa;YACrC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,iBAAiB;SAC5C,CAAC;IACN,CAAC;CACJ;AArGD,8CAqGC;AAED;;;;GAIG;AACH,SAAS,kBAAkB,CAAC,WAA8B;IACtD,IAAI,CAAC,WAAW,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;QAC1C,OAAO,SAAS,CAAC;KACpB;IAED,MAAM,cAAc,GAAiB,EAAE,CAAC;IAExC,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;QAClC,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;YAChC,cAAc,CAAC,IAAI,CAAC;gBAChB,KAAK,EAAE;oBACH,IAAI,EAAE,UAAU;oBAChB,YAAY,EAAE,UAAU;iBAC3B;aACJ,CAAC,CAAC;SACN;aAAM,IAAI,UAAU,CAAC,KAAK,IAAK,UAAgC,CAAC,GAAG,EAAE;YAClE,MAAM,GAAG,GAAI,UAAgC,CAAC,GAAG,CAAC;YAElD,6FAA6F;YAE7F,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;gBACtC,MAAM,WAAW,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBAErC,cAAc,CAAC,IAAI,CAAC;oBAChB,MAAM,EAAE;wBACJ,IAAI,EAAE,UAAU,CAAC,KAAK;wBACtB,YAAY,EAAE,UAAU,CAAC,KAAK;wBAC9B,UAAU,EAAE;4BACR,WAAW;yBACd;qBACJ;iBACJ,CAAC,CAAC;aACN;iBAAM;gBACH,cAAc,CAAC,IAAI,CAAC;oBAChB,MAAM,EAAE;wBACJ,IAAI,EAAE,UAAU,CAAC,KAAK;wBACtB,YAAY,EAAE,UAAU,CAAC,KAAK;wBAC9B,aAAa,EAAE;4BACX,GAAG;yBACN;qBACJ;iBACJ,CAAC,CAAC;aACN;SACJ;aAAM,IAAI,UAAU,CAAC,KAAK,EAAE;YACzB,cAAc,CAAC,IAAI,CAAC;gBAChB,KAAK,EAAE;oBACH,IAAI,EAAE,UAAU,CAAC,KAAK;oBACtB,YAAY,EAAE,UAAU,CAAC,KAAK;iBACjC;aACJ,CAAC,CAAC;SACN;KACJ;IAED,OAAO,cAAc,CAAC;AAC1B,CAAC;AAED;;;;GAIG;AACH,SAAS,wBAAwB,CAAC,OAAqB;IACnD,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;QAClC,OAAO,SAAS,CAAC;KACpB;IAED,MAAM,cAAc,GAAiB,EAAE,CAAC;IAExC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;QAC1B,IAAI,MAAM,CAAC,KAAK,EAAE;YACd,cAAc,CAAC,IAAI,CAAC;gBAChB,MAAM,EAAE;oBACJ,IAAI,EAAE,MAAM,CAAC,KAAK;oBAClB,YAAY,EAAE,MAAM,CAAC,KAAK;iBAC7B;aACJ,CAAC,CAAC;SACN;KACJ;IAED,OAAO,cAAc,CAAC;AAC1B,CAAC;AAED;;;;GAIG;AACH,SAAS,WAAW,CAAC,IAAU;;IAC3B,MAAM,YAAY,GAAG,EAAE,CAAC;IAExB,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,KAAK,EAAE;QAC/B,MAAM,QAAQ,GAAG,MAAA,QAAQ,CAAC,KAAK,0CAAE,GAAG,CAAC;QAErC,YAAY,CAAC,IAAI,CAAC;YACd,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,WAAW,EAAE,QAAQ,CAAC,WAAW;YACjC,WAAW,EAAE,wBAAwB,CAAC,QAAQ,CAAC,OAAO,CAAC;YACvD,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;gBACd,MAAM,EAAE,eAAM,CAAC,MAAM;gBACrB,WAAW,EAAE;oBACT,OAAO,EAAE,QAAQ;oBACjB,YAAY,EAAE,KAAK;iBACtB;aACJ,CAAC,CAAC,CAAC,SAAS;SAChB,CAAC,CAAC;KACN;IAED,OAAO;QACH,SAAS,EAAE,kBAAS,CAAC,MAAM;QAC3B,YAAY,EAAE,YAAY;KAC7B,CAAC;AACN,CAAC"}

package/lib/Translators/index.d.ts

@@ -0,0 +1,3 @@
+/*! Copyright (c) 2022, XAPPmedia */
+export * from "./TranslateRequest";
+export * from "./TranslateResponse";

package/lib/Translators/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*! Copyright (c) 2022, XAPPmedia */
+__exportStar(require("./TranslateRequest"), exports);
+__exportStar(require("./TranslateResponse"), exports);
+//# sourceMappingURL=index.js.map

package/lib/Translators/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/Translators/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oCAAoC;AACpC,qDAAmC;AACnC,sDAAoC"}

package/lib/Types.d.ts

@@ -0,0 +1,3 @@
+/*! Copyright (c) 2022, XAPPmedia */
+export declare type GbmPlatform = "google-business-messages-platform";
+export declare type GbmChannel = "google-business-messages";

package/lib/Types.js

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

package/lib/Types.js.map

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

package/lib/__tests__/Channel.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/__tests__/Channel.test.js

@@ -0,0 +1,142 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/*! Copyright (c) 2022, XAPPmedia */
+const chai = require("chai");
+const sinonChai = require("sinon-chai");
+const stentor_constants_1 = require("stentor-constants");
+const Channel_1 = require("../Channel");
+const Constants_1 = require("../Constants");
+const Guards_1 = require("../Guards");
+const Translators_1 = require("../Translators");
+chai.use(sinonChai);
+const expect = chai.expect;
+const request = {
+    type: "LAUNCH_REQUEST",
+    intentId: "LaunchRequest",
+    isNewSession: true,
+    sessionId: "sessionId",
+    userId: "userID"
+};
+const OUTPUT_WITH_REPROMPT = {
+    outputSpeech: {
+        ssml: "<speak>Welcome to the customer service</speak>",
+        displayText: "Welcome!"
+    },
+    reprompt: {
+        ssml: "<speak>Hello! Welcome!</speak>",
+        displayText: "Welcome!"
+    }
+};
+const gbmRequest = {
+    message: {
+        name: "conversations/c0a6a191-98cd-49ca-a874-11f012867d2c/messages/94FFEDC0-3C7D-4126-A513-18DFD71D228A",
+        text: "Need gutter repair",
+        createTime: "2022-10-18T16:18:57.864897Z",
+        messageId: "94FFEDC0-3C7D-4126-A513-18DFD71D228A"
+    },
+    context: {
+        placeId: "",
+        userInfo: {
+            displayName: "Joe Test",
+            userDeviceLocale: "en-US"
+        },
+        resolvedLocale: "en"
+    },
+    sendTime: "2022-10-18T16:18:58.252717Z",
+    conversationId: "c0a6a191-98cd-49ca-a874-11f012867d2c",
+    requestId: "94FFEDC0-3C7D-4126-A513-18DFD71D228A",
+    agent: "brands/96dbbf59-d0b2-412d-bf05-9510a46e49ed/agents/21bdebf1-a7c9-4331-8f03-749bb68a88a2",
+    _chat: {
+        isNewSession: false,
+        sessionId: "gmb-session-1",
+        userId: "c0a6a191-98cd-49ca-a874-11f012867d2c"
+    }
+};
+describe("google business messages channel functions", () => {
+    describe("channel creation", () => {
+        it("return channel", () => {
+            const channel = (0, Channel_1.GoogleBusinessMessages)(undefined);
+            expect(channel).to.exist;
+            expect(channel.name).to.equal(Constants_1.GOOGLE_BUSINESS_MESSAGES_PLATFORM);
+            expect(channel.request).to.be.an.instanceOf(Translators_1.TranslateRequest);
+            expect(channel.response).to.be.an.instanceOf(Translators_1.TranslateResponse);
+            expect(channel.test).to.equals(Guards_1.isGbmPayload);
+            expect(channel.capabilities).to.equals(Channel_1.capabilities);
+        });
+    });
+    describe(`device capabilities`, () => {
+        let device;
+        describe("for a request", () => {
+            beforeEach(() => {
+                device = (0, Channel_1.capabilities)(gbmRequest);
+            });
+            it("sets audio support to false", () => {
+                expect(device.audioSupported).to.be.false;
+            });
+            it("sets can play audio to false", () => {
+                expect(device.canPlayAudio).to.be.false;
+            });
+            it("sets can speak to false", () => {
+                expect(device.canSpeak).to.be.false;
+            });
+            it("sets can throw card to true", () => {
+                expect(device.canTransferCall).to.be.true;
+            });
+        });
+    });
+    describe(`test (channel snooper)`, () => {
+        let isGbmChannel;
+        describe("for a request", () => {
+            beforeEach(() => {
+                isGbmChannel = (0, Guards_1.isGbmPayload)(gbmRequest);
+            });
+            it("recognizes the channel", () => {
+                expect(isGbmChannel).to.be.true;
+            });
+        });
+    });
+    describe(`request translator`, () => {
+        let requestTranslator;
+        let translatedRequest;
+        describe("for an intent request", () => {
+            beforeEach(() => {
+                requestTranslator = new Translators_1.TranslateRequest();
+                translatedRequest = requestTranslator.translate(gbmRequest);
+            });
+            it("translates the request", () => {
+                expect(translatedRequest.platform).to.equal(Constants_1.GOOGLE_BUSINESS_MESSAGES_PLATFORM);
+                expect(translatedRequest.userId).to.equal("c0a6a191-98cd-49ca-a874-11f012867d2c");
+                expect(translatedRequest.isNewSession).to.be.false;
+                expect(translatedRequest.type).to.equal(stentor_constants_1.INTENT_REQUEST_TYPE);
+                expect(translatedRequest.locale).to.equal("en-US");
+            });
+        });
+    });
+    describe("response translator", () => {
+        let channel;
+        describe("#translate()", () => {
+            beforeEach(() => {
+                channel = (0, Channel_1.GoogleBusinessMessages)({}, {
+                    botAvatarName: "Happ el Bot", botAvatarImageUrl: "https://happ.mx/bot-avatar.jpg"
+                }); // dummy nlu
+            });
+            describe("when passed a response to say something", () => {
+                it("returns the correct payload", () => {
+                    const result = channel.response.translate({ request, response: OUTPUT_WITH_REPROMPT });
+                    result.messageId = "dummy"; // uuid. it changes.
+                    expect(result).to.deep.equal({
+                        messageId: "dummy",
+                        representative: {
+                            avatarImage: "https://happ.mx/bot-avatar.jpg",
+                            displayName: "Happ el Bot",
+                            representativeType: "BOT"
+                        },
+                        suggestions: undefined,
+                        text: "Welcome!"
+                    });
+                });
+            });
+        });
+    });
+});
+//# sourceMappingURL=Channel.test.js.map

package/lib/__tests__/Channel.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Channel.test.js","sourceRoot":"","sources":["../../src/__tests__/Channel.test.ts"],"names":[],"mappings":";;AAAA,oCAAoC;AACpC,6BAA6B;AAC7B,wCAAwC;AAExC,yDAAwD;AAGxD,wCAAkE;AAClE,4CAAiE;AACjE,sCAAyC;AACzC,gDAAqE;AAGrE,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AAEpB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;AAE3B,MAAM,OAAO,GAAY;IACrB,IAAI,EAAE,gBAAgB;IACtB,QAAQ,EAAE,eAAe;IACzB,YAAY,EAAE,IAAI;IAClB,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;CACnB,CAAC;AAEF,MAAM,oBAAoB,GAAmB;IACzC,YAAY,EAAE;QACV,IAAI,EAAE,gDAAgD;QACtD,WAAW,EAAE,UAAU;KAC1B;IACD,QAAQ,EAAE;QACN,IAAI,EAAE,gCAAgC;QACtC,WAAW,EAAE,UAAU;KAC1B;CACJ,CAAC;AAEF,MAAM,UAAU,GAAgB;IAC5B,OAAO,EAAE;QACL,IAAI,EAAE,kGAAkG;QACxG,IAAI,EAAE,oBAAoB;QAC1B,UAAU,EAAE,6BAA6B;QACzC,SAAS,EAAE,sCAAsC;KACpD;IACD,OAAO,EAAE;QACL,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE;YACN,WAAW,EAAE,UAAU;YACvB,gBAAgB,EAAE,OAAO;SAC5B;QACD,cAAc,EAAE,IAAI;KACvB;IACD,QAAQ,EAAE,6BAA6B;IACvC,cAAc,EAAE,sCAAsC;IACtD,SAAS,EAAE,sCAAsC;IACjD,KAAK,EAAE,yFAAyF;IAEhG,KAAK,EAAE;QACH,YAAY,EAAE,KAAK;QACnB,SAAS,EAAE,eAAe;QAC1B,MAAM,EAAE,sCAAsC;KACjD;CACJ,CAAC;AAEF,QAAQ,CAAC,4CAA4C,EAAE,GAAG,EAAE;IACxD,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,gBAAgB,EAAE,GAAG,EAAE;YACtB,MAAM,OAAO,GAAG,IAAA,gCAAsB,EAAC,SAAS,CAAC,CAAC;YAClD,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC;YACzB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,6CAAiC,CAAC,CAAC;YACjE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,8BAAgB,CAAC,CAAC;YAC9D,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,+BAAiB,CAAC,CAAC;YAChE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,qBAAY,CAAC,CAAC;YAC7C,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,sBAAY,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;QACjC,IAAI,MAAc,CAAC;QACnB,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;YAC3B,UAAU,CAAC,GAAG,EAAE;gBACZ,MAAM,GAAG,IAAA,sBAAY,EAAC,UAAU,CAAC,CAAC;YACtC,CAAC,CAAC,CAAC;YACH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;gBACnC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;YAC9C,CAAC,CAAC,CAAC;YACH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;gBACpC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;YAC5C,CAAC,CAAC,CAAC;YACH,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;gBAC/B,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;YACxC,CAAC,CAAC,CAAC;YACH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;gBACnC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YAC9C,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;QACpC,IAAI,YAAqB,CAAC;QAC1B,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;YAC3B,UAAU,CAAC,GAAG,EAAE;gBACZ,YAAY,GAAG,IAAA,qBAAY,EAAC,UAAU,CAAC,CAAC;YAC5C,CAAC,CAAC,CAAC;YACH,EAAE,CAAC,wBAAwB,EAAE,GAAG,EAAE;gBAC9B,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YACpC,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAChC,IAAI,iBAAmC,CAAC;QACxC,IAAI,iBAA0B,CAAC;QAE/B,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;YACnC,UAAU,CAAC,GAAG,EAAE;gBACZ,iBAAiB,GAAG,IAAI,8BAAgB,EAAE,CAAC;gBAC3C,iBAAiB,GAAG,iBAAiB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;YAEhE,CAAC,CAAC,CAAC;YACH,EAAE,CAAC,wBAAwB,EAAE,GAAG,EAAE;gBAC9B,MAAM,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,6CAAiC,CAAC,CAAC;gBAC/E,MAAM,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAC;gBAClF,MAAM,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;gBACnD,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,uCAAmB,CAAC,CAAC;gBAC7D,MAAM,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACvD,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;QACjC,IAAI,OAAgB,CAAC;QACrB,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;YAC1B,UAAU,CAAC,GAAG,EAAE;gBACZ,OAAO,GAAG,IAAA,gCAAsB,EAAC,EAAS,EAAE;oBACxC,aAAa,EAAE,aAAa,EAAE,iBAAiB,EAAE,gCAAgC;iBACpF,CAAE,CAAC,CAAC,YAAY;YACrB,CAAC,CAAC,CAAC;YACH,QAAQ,CAAC,yCAAyC,EAAE,GAAG,EAAE;gBACrD,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;oBACnC,MAAM,MAAM,GAAI,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,oBAAoB,EAAE,CAAiB,CAAC;oBACxG,MAAM,CAAC,SAAS,GAAG,OAAO,CAAC,CAAC,oBAAoB;oBAChD,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;wBACzB,SAAS,EAAE,OAAO;wBAClB,cAAc,EAAE;4BACZ,WAAW,EAAE,gCAAgC;4BAC7C,WAAW,EAAE,aAAa;4BAC1B,kBAAkB,EAAE,KAAK;yBAC5B;wBACD,WAAW,EAAE,SAAS;wBACtB,IAAI,EAAE,UAAU;qBACnB,CAAC,CAAC;gBACP,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AAEP,CAAC,CAAC,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,6 @@
+/*! Copyright (c) 2022, XAPPmedia */
+export { GoogleBusinessMessages } from "./Channel";
+export * from "./Constants";
+export * from "./Guards";
+export * from "./Translators";
+export * from "./Types";

package/lib/index.js

@@ -0,0 +1,25 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GoogleBusinessMessages = void 0;
+/*! Copyright (c) 2022, XAPPmedia */
+var Channel_1 = require("./Channel");
+Object.defineProperty(exports, "GoogleBusinessMessages", { enumerable: true, get: function () { return Channel_1.GoogleBusinessMessages; } });
+__exportStar(require("./Constants"), exports);
+__exportStar(require("./Guards"), exports);
+__exportStar(require("./Translators"), exports);
+__exportStar(require("./Types"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,oCAAoC;AACpC,qCAAmD;AAA1C,iHAAA,sBAAsB,OAAA;AAC/B,8CAA4B;AAC5B,2CAAyB;AACzB,gDAA8B;AAC9B,0CAAwB"}

package/lib/models/AgentMessage.d.ts

@@ -0,0 +1,99 @@
+/*! Copyright (c) 2022, XAPPmedia */
+export interface AgentMessage {
+    messageId: string;
+    representative: Representative;
+    suggestions?: Suggestion[];
+    fallback?: string;
+    containsRichText?: boolean;
+    name?: string;
+    text?: string;
+    image?: Image;
+    richCard?: RichCard;
+}
+export declare enum RepresentativeType {
+    REPRESENTATIVE_TYPE_UNSPECIFIED = "REPRESENTATIVE_TYPE_UNSPECIFIED",
+    BOT = "BOT",
+    HUMAN = "HUMAN"
+}
+export interface Representative {
+    displayName: string;
+    avatarImage: string;
+    representativeType: RepresentativeType;
+}
+interface SuggestedReply {
+    text: string;
+    postbackData: string;
+}
+interface OpenUrlAction {
+    url: string;
+}
+interface DialAction {
+    phoneNumber: string;
+}
+interface SuggestedAction {
+    text: string;
+    postbackData: string;
+    openUrlAction?: OpenUrlAction;
+    dialAction?: DialAction;
+}
+interface LiveAgentRequest {
+}
+interface Oauth {
+    clientId: string;
+    codeChallenge: string;
+    scopes: [
+        string
+    ];
+    codeChallengeMethod: string;
+}
+interface AuthenticationRequest {
+    oauth: Oauth;
+}
+export interface Suggestion {
+    reply?: SuggestedReply;
+    action?: SuggestedAction;
+    liveAgentRequest?: LiveAgentRequest;
+    authenticationRequest?: AuthenticationRequest;
+}
+export declare enum Height {
+    HEIGHT_UNSPECIFIED = "HEIGHT_UNSPECIFIED",
+    SHORT = "SHORT",
+    MEDIUM = "MEDIUM",
+    TALL = "TALL"
+}
+interface Media {
+    height: Height;
+    contentInfo: ContentInfo;
+}
+interface CardContent {
+    title: string;
+    description: string;
+    media: Media;
+    suggestions: Suggestion[];
+}
+interface StandaloneCard {
+    cardContent: CardContent;
+}
+export declare enum CardWidth {
+    CARD_WIDTH_UNSPECIFIED = "CARD_WIDTH_UNSPECIFIED",
+    SMALL = "SMALL",
+    MEDIUM = "MEDIUM"
+}
+export interface CarouselCard {
+    cardWidth: CardWidth;
+    cardContents: CardContent[];
+}
+export interface RichCard {
+    standaloneCard?: StandaloneCard;
+    carouselCard?: CarouselCard;
+}
+interface ContentInfo {
+    fileUrl: string;
+    thumbnailUrl?: string;
+    forceRefresh: boolean;
+    altText?: string;
+}
+export interface Image {
+    contentInfo: ContentInfo;
+}
+export {};