@botonic/plugin-flow-builder 0.21.0-alpha.0

package/lib/hubtype-models.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeContentType = exports.InputType = exports.InputContentType = exports.StartFieldsType = exports.MediaContentType = exports.SubContentType = exports.NonMessageContentType = exports.MessageContentType = exports.ButtonStyle = void 0;
+var ButtonStyle;
+(function (ButtonStyle) {
+    ButtonStyle["BUTTON"] = "button";
+    ButtonStyle["QUICK_REPLY"] = "quick-reply";
+})(ButtonStyle = exports.ButtonStyle || (exports.ButtonStyle = {}));
+var MessageContentType;
+(function (MessageContentType) {
+    MessageContentType["CAROUSEL"] = "carousel";
+    MessageContentType["IMAGE"] = "image";
+    MessageContentType["TEXT"] = "text";
+    MessageContentType["KEYWORD"] = "keyword";
+    MessageContentType["HANDOFF"] = "handoff";
+    MessageContentType["FUNCTION"] = "function";
+    MessageContentType["INTENT"] = "intent";
+})(MessageContentType = exports.MessageContentType || (exports.MessageContentType = {}));
+// TODO: refactor types correctly
+var NonMessageContentType;
+(function (NonMessageContentType) {
+    NonMessageContentType["INTENT"] = "intent";
+    NonMessageContentType["PAYLOAD"] = "payload";
+    NonMessageContentType["QUEUE"] = "queue";
+    NonMessageContentType["URL"] = "url";
+})(NonMessageContentType = exports.NonMessageContentType || (exports.NonMessageContentType = {}));
+var SubContentType;
+(function (SubContentType) {
+    SubContentType["BUTTON"] = "button";
+    SubContentType["ELEMENT"] = "element";
+})(SubContentType = exports.SubContentType || (exports.SubContentType = {}));
+var MediaContentType;
+(function (MediaContentType) {
+    MediaContentType["ASSET"] = "asset";
+})(MediaContentType = exports.MediaContentType || (exports.MediaContentType = {}));
+var StartFieldsType;
+(function (StartFieldsType) {
+    StartFieldsType["STARTUP"] = "startUp";
+})(StartFieldsType = exports.StartFieldsType || (exports.StartFieldsType = {}));
+var InputContentType;
+(function (InputContentType) {
+    InputContentType["INPUT"] = "user-input";
+})(InputContentType = exports.InputContentType || (exports.InputContentType = {}));
+var InputType;
+(function (InputType) {
+    InputType["INTENTS"] = "intents";
+    InputType["KEYWORDS"] = "keywords";
+})(InputType = exports.InputType || (exports.InputType = {}));
+exports.NodeContentType = Object.assign(Object.assign({}, MessageContentType), InputContentType);
+//# sourceMappingURL=hubtype-models.js.map

package/lib/hubtype-models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hubtype-models.js","sourceRoot":"","sources":["../src/hubtype-models.ts"],"names":[],"mappings":";;;AAAA,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,gCAAiB,CAAA;IACjB,0CAA2B,CAAA;AAC7B,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;AAED,IAAY,kBAQX;AARD,WAAY,kBAAkB;IAC5B,2CAAqB,CAAA;IACrB,qCAAe,CAAA;IACf,mCAAa,CAAA;IACb,yCAAmB,CAAA;IACnB,yCAAmB,CAAA;IACnB,2CAAqB,CAAA;IACrB,uCAAiB,CAAA;AACnB,CAAC,EARW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAQ7B;AAED,iCAAiC;AACjC,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC/B,0CAAiB,CAAA;IACjB,4CAAmB,CAAA;IACnB,wCAAe,CAAA;IACf,oCAAW,CAAA;AACb,CAAC,EALW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAKhC;AAED,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,mCAAiB,CAAA;IACjB,qCAAmB,CAAA;AACrB,CAAC,EAHW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAGzB;AAED,IAAY,gBAEX;AAFD,WAAY,gBAAgB;IAC1B,mCAAe,CAAA;AACjB,CAAC,EAFW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAE3B;AAED,IAAY,eAEX;AAFD,WAAY,eAAe;IACzB,sCAAmB,CAAA;AACrB,CAAC,EAFW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAE1B;AAED,IAAY,gBAEX;AAFD,WAAY,gBAAgB;IAC1B,wCAAoB,CAAA;AACtB,CAAC,EAFW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAE3B;AAED,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,gCAAmB,CAAA;IACnB,kCAAqB,CAAA;AACvB,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AAEY,QAAA,eAAe,mCACvB,kBAAkB,GAClB,gBAAgB,EACpB"}

package/lib/index.d.ts

@@ -0,0 +1,30 @@
+import { Input, Plugin, PluginPostRequest, PluginPreRequest } from '@botonic/core';
+import { FlowContent } from './content-fields/content-base';
+import { HtFlowBuilderData, HtFunctionNode, HtHandoffNode, HtIntentNode, HtKeywordNode, HtNodeComponent } from './hubtype-models';
+declare type BotonicPluginFlowBuilderOptions = {
+    flowUrl: string;
+    flow: any;
+    customFunctions: Record<any, any>;
+};
+export default class BotonicPluginFlowBuilder implements Plugin {
+    readonly options: BotonicPluginFlowBuilderOptions;
+    private flowUrl;
+    private flow;
+    private functions;
+    private currentRequest;
+    constructor(options: BotonicPluginFlowBuilderOptions);
+    readFlowContent(): Promise<HtFlowBuilderData>;
+    pre(request: PluginPreRequest): Promise<void>;
+    post(_request: PluginPostRequest): Promise<void>;
+    getContent(id: string): Promise<HtNodeComponent>;
+    getHandoffContent(): Promise<HtHandoffNode>;
+    getFlowContent(hubtypeContent: HtNodeComponent, locale: string): FlowContent | undefined;
+    getContents(id: string, locale: string, prevContents?: FlowContent[]): Promise<FlowContent[]>;
+    getPayloadByInput(input: Input, locale: string): Promise<string | undefined>;
+    hasIntent(node: HtIntentNode, intent: string, locale: string): boolean;
+    getPayloadByKeyword(input: Input, locale: string): Promise<string | undefined>;
+    matchKeywords(node: HtKeywordNode, input: string, locale: string): boolean;
+    containsAnyKeywords(input: string, keywords: string[]): boolean;
+    callFunction(functionNode: HtFunctionNode, locale: string): Promise<string>;
+}
+export {};

package/lib/index.js

@@ -0,0 +1,171 @@
+"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 };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+const carousel_1 = require("./content-fields/carousel");
+const image_1 = require("./content-fields/image");
+const text_1 = require("./content-fields/text");
+const functions_1 = require("./functions");
+const hubtype_models_1 = require("./hubtype-models");
+class BotonicPluginFlowBuilder {
+    constructor(options) {
+        this.options = options;
+        this.flowUrl = options.flowUrl;
+        this.flow = options.flow || this.readFlowContent();
+        const customFunctions = options.customFunctions || {};
+        this.functions = Object.assign(Object.assign({}, functions_1.DEFAULT_FUNCTIONS), customFunctions);
+    }
+    readFlowContent() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield axios_1.default.get(this.flowUrl);
+            const data = yield response.data;
+            //@ts-ignore
+            return Promise.resolve(data);
+        });
+    }
+    pre(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.currentRequest = request;
+        });
+    }
+    post(_request) {
+        return __awaiter(this, void 0, void 0, function* () { });
+    }
+    getContent(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const flow = yield this.flow;
+            const content = flow.nodes.find((c) => c.id === id);
+            if (!content)
+                throw Error(`text with id: '${id}' not found`);
+            return content;
+        });
+    }
+    getHandoffContent() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const flow = yield this.flow;
+            const content = flow.nodes.find((c) => c.type === 'handoff');
+            if (!content)
+                throw Error(`Handoff node not found`);
+            return content;
+        });
+    }
+    getFlowContent(hubtypeContent, locale) {
+        switch (hubtypeContent.type) {
+            case hubtype_models_1.MessageContentType.TEXT:
+                return text_1.FlowText.fromHubtypeCMS(hubtypeContent, locale);
+            case hubtype_models_1.MessageContentType.IMAGE:
+                return image_1.FlowImage.fromHubtypeCMS(hubtypeContent, locale);
+            case hubtype_models_1.MessageContentType.CAROUSEL:
+                return carousel_1.FlowCarousel.fromHubtypeCMS(hubtypeContent, locale);
+            default:
+                return undefined;
+        }
+    }
+    getContents(id, locale, prevContents) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const contents = prevContents || [];
+            const hubtypeContent = yield this.getContent(id);
+            const content = yield this.getFlowContent(hubtypeContent, locale);
+            if (hubtypeContent.type === hubtype_models_1.MessageContentType.FUNCTION) {
+                const targetId = yield this.callFunction(hubtypeContent, locale);
+                return this.getContents(targetId, locale, contents);
+            }
+            else {
+                if (content)
+                    contents.push(content);
+                // TODO: prevent infinite recursive calls
+                if (hubtypeContent.follow_up)
+                    return this.getContents(hubtypeContent.follow_up.id, locale, contents);
+            }
+            // execute function
+            // return this.getContents(function result_mapping target, locale, contents)
+            return contents;
+        });
+    }
+    getPayloadByInput(input, locale) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const flow = yield this.flow;
+                const intents = flow.nodes.filter(node => node.type == hubtype_models_1.MessageContentType.INTENT);
+                if (input.intent) {
+                    const matchedIntents = intents.filter(node => 
+                    //@ts-ignore
+                    this.hasIntent(node, input.intent, locale));
+                    if (matchedIntents.length > 0) {
+                        return (_a = matchedIntents[0].target) === null || _a === void 0 ? void 0 : _a.id;
+                    }
+                }
+            }
+            catch (error) {
+                console.error('Error getting payload by input: ', error);
+            }
+            return undefined;
+        });
+    }
+    hasIntent(node, intent, locale) {
+        const result = node.content.intents.find(i => i.locale === locale && i.values.includes(intent));
+        return Boolean(result);
+    }
+    getPayloadByKeyword(input, locale) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const flow = yield this.flow;
+                const keywordNodes = flow.nodes.filter(node => node.type == hubtype_models_1.MessageContentType.KEYWORD);
+                const matchedKeywordNodes = keywordNodes.filter(node => 
+                //@ts-ignore
+                this.matchKeywords(node, input.data, locale));
+                if (matchedKeywordNodes.length > 0) {
+                    return (_a = matchedKeywordNodes[0].target) === null || _a === void 0 ? void 0 : _a.id;
+                }
+            }
+            catch (error) {
+                console.error('Error getting payload by input: ', error);
+            }
+            return undefined;
+        });
+    }
+    matchKeywords(node, input, locale) {
+        const result = node.content.keywords.find(i => i.locale === locale && this.containsAnyKeywords(input, i.values));
+        return Boolean(result);
+    }
+    containsAnyKeywords(input, keywords) {
+        for (let i = 0; i < keywords.length; i++) {
+            if (input.includes(keywords[i])) {
+                return true;
+            }
+        }
+        return false;
+    }
+    callFunction(functionNode, locale) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // Check if target is missing or missing arguments
+            // TODO: get arguments by locale
+            const nameValues = functionNode.content.arguments
+                .find(arg => arg.locale === locale)
+                .values.map(value => ({ [value.name]: value.value }));
+            const args = Object.assign({
+                session: this.currentRequest.session,
+                results: [functionNode.content.result_mapping.map(r => r.result)],
+            }, ...nameValues);
+            const functionResult = yield this.functions[functionNode.content.subtype](args);
+            // TODO define result_mapping per locale??
+            const result = functionNode.content.result_mapping.find(r => r.result === functionResult);
+            return result.target.id;
+        });
+    }
+}
+exports.default = BotonicPluginFlowBuilder;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAMA,kDAAyB;AAEzB,wDAAwD;AAExD,kDAAkD;AAClD,gDAAgD;AAChD,2CAA+C;AAC/C,qDASyB;AAQzB,MAAqB,wBAAwB;IAM3C,YAAqB,OAAwC;QAAxC,YAAO,GAAP,OAAO,CAAiC;QAC3D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;QAC9B,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,eAAe,EAAE,CAAA;QAClD,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,EAAE,CAAA;QACrD,IAAI,CAAC,SAAS,mCAAQ,6BAAiB,GAAK,eAAe,CAAE,CAAA;IAC/D,CAAC;IAEK,eAAe;;YACnB,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC9C,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAA;YAChC,YAAY;YACZ,OAAO,OAAO,CAAC,OAAO,CAAC,IAAyB,CAAC,CAAA;QACnD,CAAC;KAAA;IAEK,GAAG,CAAC,OAAyB;;YACjC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAA;QAC/B,CAAC;KAAA;IAEK,IAAI,CAAC,QAA2B;8DAAkB,CAAC;KAAA;IAEnD,UAAU,CAAC,EAAU;;YACzB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;YAC5B,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAa,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAA;YAC/D,IAAI,CAAC,OAAO;gBAAE,MAAM,KAAK,CAAC,kBAAkB,EAAE,aAAa,CAAC,CAAA;YAC5D,OAAO,OAAO,CAAA;QAChB,CAAC;KAAA;IAEK,iBAAiB;;YACrB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;YAC5B,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAC7B,CAAC,CAAkB,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAC5B,CAAA;YAClB,IAAI,CAAC,OAAO;gBAAE,MAAM,KAAK,CAAC,wBAAwB,CAAC,CAAA;YACnD,OAAO,OAAO,CAAA;QAChB,CAAC;KAAA;IAED,cAAc,CACZ,cAA+B,EAC/B,MAAc;QAEd,QAAQ,cAAc,CAAC,IAAI,EAAE;YAC3B,KAAK,mCAAkB,CAAC,IAAI;gBAC1B,OAAO,eAAQ,CAAC,cAAc,CAAC,cAAc,EAAE,MAAM,CAAC,CAAA;YACxD,KAAK,mCAAkB,CAAC,KAAK;gBAC3B,OAAO,iBAAS,CAAC,cAAc,CAAC,cAAc,EAAE,MAAM,CAAC,CAAA;YACzD,KAAK,mCAAkB,CAAC,QAAQ;gBAC9B,OAAO,uBAAY,CAAC,cAAc,CAAC,cAAc,EAAE,MAAM,CAAC,CAAA;YAC5D;gBACE,OAAO,SAAS,CAAA;SACnB;IACH,CAAC;IAEK,WAAW,CACf,EAAU,EACV,MAAc,EACd,YAA4B;;YAE5B,MAAM,QAAQ,GAAG,YAAY,IAAI,EAAE,CAAA;YACnC,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAA;YAChD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,MAAM,CAAC,CAAA;YACjE,IAAI,cAAc,CAAC,IAAI,KAAK,mCAAkB,CAAC,QAAQ,EAAE;gBACvD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,CACtC,cAAgC,EAChC,MAAM,CACP,CAAA;gBACD,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAA;aACpD;iBAAM;gBACL,IAAI,OAAO;oBAAE,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;gBACnC,yCAAyC;gBACzC,IAAI,cAAc,CAAC,SAAS;oBAC1B,OAAO,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAA;aACzE;YACD,mBAAmB;YACnB,4EAA4E;YAC5E,OAAO,QAAQ,CAAA;QACjB,CAAC;KAAA;IAEK,iBAAiB,CACrB,KAAY,EACZ,MAAc;;;YAEd,IAAI;gBACF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;gBAC5B,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAC/B,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,IAAI,mCAAkB,CAAC,MAAM,CAC7B,CAAA;gBACnB,IAAI,KAAK,CAAC,MAAM,EAAE;oBAChB,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;oBAC3C,YAAY;oBACZ,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAC3C,CAAA;oBACD,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;wBAC7B,OAAO,MAAA,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,0CAAE,EAAE,CAAA;qBACpC;iBACF;aACF;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,CAAC,KAAK,CAAC,kCAAkC,EAAE,KAAK,CAAC,CAAA;aACzD;YAED,OAAO,SAAS,CAAA;;KACjB;IAED,SAAS,CAAC,IAAkB,EAAE,MAAc,EAAE,MAAc;QAC1D,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CACtC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CACtD,CAAA;QACD,OAAO,OAAO,CAAC,MAAM,CAAC,CAAA;IACxB,CAAC;IAEK,mBAAmB,CACvB,KAAY,EACZ,MAAc;;;YAEd,IAAI;gBACF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;gBAC5B,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CACpC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,IAAI,mCAAkB,CAAC,OAAO,CAC7B,CAAA;gBACpB,MAAM,mBAAmB,GAAG,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;gBACrD,YAAY;gBACZ,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAC7C,CAAA;gBACD,IAAI,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE;oBAClC,OAAO,MAAA,mBAAmB,CAAC,CAAC,CAAC,CAAC,MAAM,0CAAE,EAAE,CAAA;iBACzC;aACF;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,CAAC,KAAK,CAAC,kCAAkC,EAAE,KAAK,CAAC,CAAA;aACzD;YAED,OAAO,SAAS,CAAA;;KACjB;IAED,aAAa,CAAC,IAAmB,EAAE,KAAa,EAAE,MAAc;QAC9D,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CACvC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,IAAI,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CACtE,CAAA;QACD,OAAO,OAAO,CAAC,MAAM,CAAC,CAAA;IACxB,CAAC;IAED,mBAAmB,CAAC,KAAa,EAAE,QAAkB;QACnD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACxC,IAAI,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE;gBAC/B,OAAO,IAAI,CAAA;aACZ;SACF;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAEK,YAAY,CAChB,YAA4B,EAC5B,MAAc;;YAEd,kDAAkD;YAClD,gCAAgC;YAChC,MAAM,UAAU,GAAG,YAAY,CAAC,OAAO,CAAC,SAAS;iBAC9C,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,MAAM,CAAC;iBAClC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;YACvD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CACxB;gBACE,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,OAAO;gBACpC,OAAO,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;aAClE,EACD,GAAG,UAAU,CACd,CAAA;YACD,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,CACvE,IAAI,CACL,CAAA;YACD,0CAA0C;YAC1C,MAAM,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CACrD,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,cAAc,CACjC,CAAA;YACD,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,CAAA;QACzB,CAAC;KAAA;CACF;AAnLD,2CAmLC"}

package/lib/utils.d.ts

@@ -0,0 +1,2 @@
+import { HtMediaFileLocale } from './hubtype-models';
+export declare function getImageByLocale(locale: string, image: HtMediaFileLocale[]): string;

package/lib/utils.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getImageByLocale = void 0;
+function getImageByLocale(locale, image) {
+    var _a;
+    const result = image.find(t => t.locale == locale);
+    return (_a = result === null || result === void 0 ? void 0 : result.file) !== null && _a !== void 0 ? _a : '';
+}
+exports.getImageByLocale = getImageByLocale;
+//# sourceMappingURL=utils.js.map

package/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAEA,SAAgB,gBAAgB,CAAC,MAAc,EAAE,KAA0B;;IACzE,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,MAAM,CAAC,CAAA;IAClD,OAAO,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,mCAAI,EAAE,CAAA;AAC3B,CAAC;AAHD,4CAGC"}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@botonic/plugin-flow-builder",
+  "version": "0.21.0-alpha.0",
+  "main": "lib/index.js",
+  "description": "Use Flow Builder to show your contents",
+  "scripts": {
+    "build": "rm -rf lib && ../../node_modules/.bin/tsc",
+    "build:watch": "../../node_modules/.bin/tsc --watch",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "cloc": "../../scripts/qa/cloc-package.sh .",
+    "prepare": "node ../../preinstall.js",
+    "prepublishOnly": "rm -rf lib && npm run build",
+    "lint": "npm run lint_core -- --fix",
+    "lint_ci": "npm run lint_core -- -c ../.eslintrc_slow.js",
+    "lint_core": "../../node_modules/.bin/eslint_d --cache --quiet 'src/**/*.ts*'"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hubtype/botonic.git"
+  },
+  "author": "",
+  "bugs": {
+    "url": "https://github.com/hubtype/botonic/issues"
+  },
+  "files": [
+    "lib/**",
+    "src/**",
+    "README.md"
+  ],
+  "devDependencies": {
+    "@types/node": "^18.13.0",
+    "@types/react": "^18.0.28",
+    "typescript": "^4.9.5"
+  },
+  "keywords": [
+    "bot-framework",
+    "chatbot",
+    "flow-builder",
+    "conversational-app",
+    "conversational-ui",
+    "javascript"
+  ],
+  "eslintConfig": {
+    "extends": "../.eslintrc.js",
+    "root": true
+  },
+  "dependencies": {
+    "@babel/runtime": "^7.20.13",
+    "@botonic/core": "^0.21.0",
+    "@botonic/react": "^0.21.0",
+    "axios": "^1.3.3"
+  }
+}

package/src/action.tsx

@@ -0,0 +1,62 @@
+import { ActionRequest, RequestContext, Text } from '@botonic/react'
+import React from 'react'
+
+import { FlowContent } from './content-fields/content-base'
+import { doHandoff } from './handoff'
+import { HtHandoffNode } from './hubtype-models'
+
+// TODO: remove this from here and use the new "start" attribute in the flow
+export const START = '08c7df06-0c7c-4f06-b8c1-4157582efeb2'
+
+type FlowBuilderActionProps = {
+  content?: FlowContent[]
+  handoffMsg?: HtHandoffNode
+}
+
+export default class FlowBuilderAction extends React.Component<FlowBuilderActionProps> {
+  static contextType = RequestContext
+
+  static async botonicInit(request: ActionRequest): Promise<any> {
+    const flowBuilderPlugin = request.plugins.hubtypeFlowBuilder as any
+
+    let payload = request.input.payload ? request.input.payload : START
+    if (!request.input.payload) {
+      const intentPayload = await flowBuilderPlugin.getPayloadByInput(
+        request.input,
+        'es-ES'
+      )
+      if (intentPayload) {
+        payload = intentPayload
+      }
+      const keywordPayload = await flowBuilderPlugin.getPayloadByKeyword(
+        request.input,
+        'es-ES'
+      )
+      if (keywordPayload) {
+        payload = keywordPayload
+      }
+    }
+    // We use only Spanish because they are the backend examples
+    const content = await flowBuilderPlugin.getContents(payload, 'es-ES')
+
+    if (content.length == 0) {
+      const handoffMsg = await doHandoff(request)
+      return { handoffMsg }
+    }
+    return { content }
+  }
+
+  render() {
+    // @ts-ignore
+    const { content: contents, handoffMsg } = this.props
+    if (handoffMsg) {
+      // @ts-ignore
+      return <Text>{handoffMsg}</Text>
+    } else {
+      return contents!.map((content, index) => {
+        console.log({ content, index })
+        return content.toBotonic(index)
+      })
+    }
+  }
+}

package/src/content-fields/button.tsx

@@ -0,0 +1,34 @@
+import { Button, Reply } from '@botonic/react'
+import React from 'react'
+
+import { ButtonStyle, HtButton } from '../hubtype-models'
+import { ContentFieldsBase } from './content-base'
+
+export class FlowButton extends ContentFieldsBase {
+  public text = ''
+  public url?: string
+  public payload?: string
+
+  static fromHubtypeCMS(component: HtButton, locale: string): FlowButton {
+    const newButton = new FlowButton(component.id)
+    newButton.text = FlowButton.getTextByLocale(locale, component.text)
+    newButton.payload = component.target?.id
+    return newButton
+  }
+
+  renderButton(index: number, buttonStyle: ButtonStyle) {
+    if (buttonStyle == ButtonStyle.QUICK_REPLY) {
+      return (
+        <Reply payload={this.payload} key={index}>
+          {this.text}
+        </Reply>
+      )
+    }
+    return (
+      // @ts-ignore
+      <Button payload={this.payload} key={index}>
+        {this.text}
+      </Button>
+    )
+  }
+}

package/src/content-fields/carousel.tsx

@@ -0,0 +1,42 @@
+import { Button, Carousel, Element, Pic, Subtitle, Title } from '@botonic/react'
+import React from 'react'
+
+import { HtCarouselNode } from '../hubtype-models'
+import { ContentFieldsBase } from './content-base'
+import { FlowElement } from './element'
+
+export class FlowCarousel extends ContentFieldsBase {
+  public code = ''
+  public elements: FlowElement[] = []
+
+  static fromHubtypeCMS(
+    component: HtCarouselNode,
+    locale: string
+  ): FlowCarousel {
+    const newCarousel = new FlowCarousel(component.id)
+    newCarousel.code = component.code
+    newCarousel.elements = component.content.elements.map(ele =>
+      FlowElement.fromHubtypeCMS(ele, locale)
+    )
+    return newCarousel
+  }
+
+  toBotonic(index: number) {
+    return (
+      <Carousel key={index}>
+        {this.elements.map((e, eIndex) => {
+          console.log('TO BOTONIC BOTONIC PACKAGES', { e })
+          return (
+            <Element key={eIndex}>
+              <Pic src={e.image} />
+              <Title style=''>{e.title}</Title>
+              <Subtitle style=''>{e.subtitle}</Subtitle>
+              {/* @ts-ignore */}
+              <Button payload={e.buttons?.payload}>{e.buttons?.text}</Button>,
+            </Element>
+          )
+        })}
+      </Carousel>
+    )
+  }
+}

package/src/content-fields/content-base.ts

@@ -0,0 +1,15 @@
+import { HtTextLocale } from '../hubtype-models'
+import { FlowCarousel } from './carousel'
+import { FlowImage } from './image'
+import { FlowText } from './text'
+
+export abstract class ContentFieldsBase {
+  constructor(private readonly id: string) {}
+
+  static getTextByLocale(locale: string, text: HtTextLocale[]) {
+    const result = text.find(t => t.locale == locale)
+    return result?.message ?? ''
+  }
+}
+
+export type FlowContent = FlowText | FlowImage | FlowCarousel

package/src/content-fields/element.tsx

@@ -0,0 +1,24 @@
+import { HtElement } from '../hubtype-models'
+import { getImageByLocale } from '../utils'
+import { FlowButton } from './button'
+import { ContentFieldsBase } from './content-base'
+
+export class FlowElement extends ContentFieldsBase {
+  public title = ''
+  public subtitle = ''
+  public buttons: FlowButton | undefined
+  public image = ''
+  public hidden = false
+
+  static fromHubtypeCMS(component: HtElement, locale: string): FlowElement {
+    const newElement = new FlowElement(component.id)
+    newElement.title = FlowElement.getTextByLocale(locale, component.title)
+    newElement.subtitle = FlowElement.getTextByLocale(
+      locale,
+      component.subtitle
+    )
+    newElement.image = getImageByLocale(locale, component.image)
+    newElement.buttons = FlowButton.fromHubtypeCMS(component.button, locale)
+    return newElement
+  }
+}

package/src/content-fields/image.tsx

@@ -0,0 +1,22 @@
+import { Image } from '@botonic/react'
+import React from 'react'
+
+import { HtImageNode } from '../hubtype-models'
+import { getImageByLocale } from '../utils'
+import { ContentFieldsBase } from './content-base'
+
+export class FlowImage extends ContentFieldsBase {
+  public src = ''
+  public code = ''
+
+  static fromHubtypeCMS(component: HtImageNode, locale: string): FlowImage {
+    const newImage = new FlowImage(component.id)
+    newImage.code = component.code
+    newImage.src = getImageByLocale(locale, component.content.image)
+    return newImage
+  }
+
+  toBotonic(index: number) {
+    return <Image src={this.src} key={index} />
+  }
+}

package/src/content-fields/text.tsx

@@ -0,0 +1,35 @@
+import { Text } from '@botonic/react'
+import React from 'react'
+
+import { ButtonStyle, HtTextNode } from '../hubtype-models'
+import { FlowButton } from './button'
+import { ContentFieldsBase } from './content-base'
+
+export class FlowText extends ContentFieldsBase {
+  public text = ''
+  public code = ''
+  public buttons: FlowButton[] = []
+  public buttonStyle = ButtonStyle.BUTTON
+
+  static fromHubtypeCMS(component: HtTextNode, locale: string): FlowText {
+    const newText = new FlowText(component.id)
+    newText.code = component.code
+    newText.buttonStyle = component.content.buttons_style || ButtonStyle.BUTTON
+    newText.text = FlowText.getTextByLocale(locale, component.content.text)
+    newText.buttons = component.content.buttons.map(button =>
+      FlowButton.fromHubtypeCMS(button, locale)
+    )
+    return newText
+  }
+
+  toBotonic(index: number) {
+    return (
+      <Text key={index}>
+        {this.text}
+        {this.buttons.map((button, index) =>
+          button.renderButton(index, this.buttonStyle)
+        )}
+      </Text>
+    )
+  }
+}

package/src/functions/conditional-provider.ts

@@ -0,0 +1,5 @@
+export function conditionalProvider({ session, results }): string {
+  const provider = session.user.provider
+  if (results.includes(provider)) return provider
+  return 'default'
+}

package/src/functions/conditional-queue-status.ts

@@ -0,0 +1,9 @@
+import axios from 'axios'
+
+export async function conditionalQueueStatus({ queueId }): Promise<string> {
+  const response = await axios.get(
+    `https://api.hubtype.com/v1/queues/${queueId}/availability/`
+  )
+  const isAvailable = response.data.available
+  return isAvailable ? 'open' : 'closed'
+}

package/src/functions/index.ts

@@ -0,0 +1,7 @@
+import { conditionalProvider } from './conditional-provider'
+import { conditionalQueueStatus } from './conditional-queue-status'
+
+export const DEFAULT_FUNCTIONS = {
+  'conditional-queue-status': conditionalQueueStatus,
+  'conditional-provider': conditionalProvider,
+}

package/src/handoff.ts

@@ -0,0 +1,27 @@
+import { getOpenQueues, HandOffBuilder } from '@botonic/core'
+import { ActionRequest } from '@botonic/react'
+
+// TODO: Remove all "getOpenQueues" logic and open/closed messages.
+// This function should just do a basic handoff
+// TODO: add missing options: withNote, withAgent
+
+export async function doHandoff(request: ActionRequest) {
+  // @ts-ignore
+  const flowBuilderPlugin = request.plugins.hubtypeFlowBuilder as any
+  const handoffContent = await flowBuilderPlugin.getHandoffContent()
+  console.log(handoffContent)
+  // @ts-ignore
+  let openQueues = await getOpenQueues(request.session)
+  const queueName = 'Test'
+  if (openQueues.queues.indexOf(queueName) !== -1) {
+    // @ts-ignore
+    const handOffBuilder = new HandOffBuilder(request.session)
+    handOffBuilder.withQueue('Test')
+    handOffBuilder.withOnFinishPayload(handoffContent.target?.id!)
+    await handOffBuilder.handOff()
+
+    return handoffContent.content.message[0].message
+  }
+
+  return handoffContent.content.failMessage[0].message
+}