@botonic/core 1.0.0-alpha.0 → 1.0.0-dev.2

package/lib/cjs/models/session.d.ts

@@ -0,0 +1,3 @@
+export interface Session {
+    [key: string]: any;
+}

package/lib/cjs/models/session.js

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

package/lib/cjs/models/session.js.map

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

package/lib/cjs/models/user.d.ts

@@ -0,0 +1,14 @@
+import { BotState } from './bot-state';
+import { Session } from './session';
+export interface User {
+    id: string;
+    name?: string;
+    userName?: string;
+    channel: string;
+    idFromChannel: string;
+    session: Session;
+    botState: BotState;
+    isOnline: boolean;
+    websocketId?: string;
+    locationInfo: string;
+}

package/lib/{models → cjs/models}/user.js.map

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

package/lib/cjs/output-parser/botonic-output-parser.d.ts

@@ -0,0 +1,16 @@
+import { BotonicEvent } from '../models';
+import { MessageParsingFactory } from './factory';
+export declare const TEXT_NODE_NAME = "text";
+export declare class BotonicOutputParser {
+    private readonly factory;
+    private static OPTIONS;
+    constructor(factory?: MessageParsingFactory);
+    xmlToMessageEvents(html: string): Partial<BotonicEvent>[];
+    /**
+     * Right now, when saving BotonicEvents to DataProvider, we need the standarized Botonic event
+     * to be saved. This is, converting a botonic input like: '{id: 'msgId', data: 'rawData', payload: 'somePayload'}'
+     * into a BotonicEvent with the expected properties.
+     */
+    inputToBotonicEvent(input: any): Partial<BotonicEvent>;
+    private xmlToJSONMessages;
+}

package/lib/{output-parser/index.js → cjs/output-parser/botonic-output-parser.js}

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BotonicOutputParser = exports.TEXT_NODE_NAME = void 0;
+// eslint-disable-next-line import/named
 const fast_xml_parser_1 = require("fast-xml-parser");
 const html_entities_1 = require("html-entities");
 const factory_1 = require("./factory");
@@ -13,7 +14,12 @@ class BotonicOutputParser {
         const jsonMessages = this.xmlToJSONMessages(html);
         return jsonMessages.map(msgToParse => this.factory.parse(msgToParse));
     }
-    parseFromUserInput(input) {
+    /**
+     * Right now, when saving BotonicEvents to DataProvider, we need the standarized Botonic event
+     * to be saved. This is, converting a botonic input like: '{id: 'msgId', data: 'rawData', payload: 'somePayload'}'
+     * into a BotonicEvent with the expected properties.
+     */
+    inputToBotonicEvent(input) {
         return this.factory.parse(input);
     }
     xmlToJSONMessages(html) {
@@ -28,4 +34,4 @@ BotonicOutputParser.OPTIONS = {
     arrayMode: true,
     attrValueProcessor: a => html_entities_1.decode(a),
 };
-//# sourceMappingURL=index.js.map
+//# sourceMappingURL=botonic-output-parser.js.map

package/lib/cjs/output-parser/botonic-output-parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"botonic-output-parser.js","sourceRoot":"","sources":["../../../src/output-parser/botonic-output-parser.ts"],"names":[],"mappings":";;;AAAA,wCAAwC;AACxC,qDAAmD;AACnD,iDAAsC;AAGtC,uCAAiD;AAEpC,QAAA,cAAc,GAAG,MAAM,CAAA;AAEpC,MAAa,mBAAmB;IAS9B,YAA6B,UAAU,IAAI,+BAAqB,EAAE;QAArC,YAAO,GAAP,OAAO,CAA8B;IAAG,CAAC;IAEtE,kBAAkB,CAAC,IAAY;QAC7B,MAAM,YAAY,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;QACjD,OAAO,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAA;IACvE,CAAC;IAED;;;;OAIG;IACH,mBAAmB,CAAC,KAAU;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IAClC,CAAC;IAEO,iBAAiB,CAAC,IAAS;QACjC,OAAO,uBAAK,CAAC,IAAI,EAAE,mBAAmB,CAAC,OAAO,CAAC,CAAC,OAAO,CAAA;IACzD,CAAC;;AA3BH,kDA4BC;AA3BgB,2BAAO,GAAwB;IAC5C,gBAAgB,EAAE,KAAK;IACvB,mBAAmB,EAAE,EAAE;IACvB,YAAY,EAAE,sBAAc;IAC5B,SAAS,EAAE,IAAI;IACf,kBAAkB,EAAE,CAAC,CAAC,EAAE,CAAC,sBAAM,CAAC,CAAC,CAAC;CACnC,CAAA"}

package/lib/{output-parser → cjs/output-parser}/factory.d.ts

@@ -1,4 +1,4 @@
-import { BotonicEvent } from '../models/events';
+import { BotonicEvent } from '../models';
 export declare class MessageParsingFactory {
     parse(msgToParse: any): Partial<BotonicEvent>;
 }

package/lib/{output-parser → cjs/output-parser}/factory.js

@@ -1,26 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MessageParsingFactory = void 0;
-const message_1 = require("../models/events/message");
-const media_1 = require("../models/events/message/media");
+const models_1 = require("../models");
 const parsers_1 = require("./parsers");
 class MessageParsingFactory {
     parse(msgToParse) {
         const type = msgToParse.type;
         const parsedMessage = parsers_1.parseMessage({ toParse: msgToParse });
-        if (type === message_1.MessageEventTypes.TEXT) {
+        if (type === models_1.MessageEventTypes.TEXT) {
             return parsers_1.parseText(parsers_1.parseReplies(parsers_1.parseButtons(parsedMessage))).parsed;
         }
-        if (media_1.MEDIA_TYPES.includes(type)) {
+        if (type === models_1.MessageEventTypes.POSTBACK) {
+            return parsers_1.parsePostback(parsedMessage).parsed;
+        }
+        if (models_1.MEDIA_TYPES.includes(type)) {
             return parsers_1.parseMedia(parsers_1.parseButtons(parsedMessage)).parsed;
         }
-        if (type === message_1.MessageEventTypes.LOCATION) {
+        if (type === models_1.MessageEventTypes.LOCATION) {
             return parsers_1.parseLocation(parsedMessage).parsed;
         }
-        if (type === message_1.MessageEventTypes.CAROUSEL) {
+        if (type === models_1.MessageEventTypes.CAROUSEL) {
             return parsers_1.parseCarousel(parsedMessage).parsed;
         }
-        if (type === message_1.MessageEventTypes.CUSTOM) {
+        if (type === models_1.MessageEventTypes.CUSTOM) {
             return parsers_1.parseCustom(parsers_1.parseReplies(parsedMessage)).parsed;
         }
         throw new Error(`Parsing for type: '${type}' not implemented.`);

package/lib/cjs/output-parser/factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.js","sourceRoot":"","sources":["../../../src/output-parser/factory.ts"],"names":[],"mappings":";;;AAAA,sCAAwE;AACxE,uCAUkB;AAElB,MAAa,qBAAqB;IAChC,KAAK,CAAC,UAAe;QACnB,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAA;QAC5B,MAAM,aAAa,GAAG,sBAAY,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAA;QAC3D,IAAI,IAAI,KAAK,0BAAiB,CAAC,IAAI,EAAE;YACnC,OAAO,mBAAS,CAAC,sBAAY,CAAC,sBAAY,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;SACnE;QACD,IAAI,IAAI,KAAK,0BAAiB,CAAC,QAAQ,EAAE;YACvC,OAAO,uBAAa,CAAC,aAAa,CAAC,CAAC,MAAM,CAAA;SAC3C;QACD,IAAI,oBAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YAC9B,OAAO,oBAAU,CAAC,sBAAY,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAA;SACtD;QACD,IAAI,IAAI,KAAK,0BAAiB,CAAC,QAAQ,EAAE;YACvC,OAAO,uBAAa,CAAC,aAAa,CAAC,CAAC,MAAM,CAAA;SAC3C;QACD,IAAI,IAAI,KAAK,0BAAiB,CAAC,QAAQ,EAAE;YACvC,OAAO,uBAAa,CAAC,aAAa,CAAC,CAAC,MAAM,CAAA;SAC3C;QACD,IAAI,IAAI,KAAK,0BAAiB,CAAC,MAAM,EAAE;YACrC,OAAO,qBAAW,CAAC,sBAAY,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAA;SACvD;QACD,MAAM,IAAI,KAAK,CAAC,sBAAsB,IAAI,oBAAoB,CAAC,CAAA;IACjE,CAAC;CACF;AAxBD,sDAwBC"}

package/lib/cjs/output-parser/index.d.ts

@@ -0,0 +1,3 @@
+export * from './botonic-output-parser';
+export * from './factory';
+export * from './parsers';

package/lib/cjs/output-parser/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./botonic-output-parser"), exports);
+tslib_1.__exportStar(require("./factory"), exports);
+tslib_1.__exportStar(require("./parsers"), exports);
+//# sourceMappingURL=index.js.map

package/lib/cjs/output-parser/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/output-parser/index.ts"],"names":[],"mappings":";;;AAAA,kEAAuC;AACvC,oDAAyB;AACzB,oDAAyB"}

package/lib/{output-parser → cjs/output-parser}/parsers.d.ts

@@ -1,11 +1,6 @@
-import { BotonicMessageEvent } from '../models/events/message';
-import { Button, WithButtons } from '../models/events/message/buttons';
-import { CarouselElement, CarouselMessageEvent } from '../models/events/message/carousel';
-import { CustomMessageEvent } from '../models/events/message/custom';
-import { LocationMessageEvent } from '../models/events/message/location';
-import { AudioMessageEvent, DocumentMessageEvent, ImageMessageEvent, VideoMessageEvent } from '../models/events/message/media';
-import { Reply, WithReplies } from '../models/events/message/replies';
-import { TextMessageEvent } from '../models/events/message/text';
+import { AudioMessageEvent, BotonicMessageEvent, Button, CarouselElement, CarouselMessageEvent, CustomMessageEvent, DocumentMessageEvent, ImageMessageEvent, LocationMessageEvent, PostbackMessageEvent, Reply, TextMessageEvent, VideoMessageEvent, WithButtons, WithReplies } from '../models';
+export declare function parseNumber(strNumber: string): number;
+export declare function parseBoolean(strNumber: string): boolean;
 export declare type ParseFunction<Out> = (args: {
     toParse: any;
     parsed?: any;
@@ -19,6 +14,7 @@ export declare const parseButtons: ParseFunction<WithButtons>;
 export declare const parseReply: (reply: any) => Reply;
 export declare const parseReplies: ParseFunction<WithReplies>;
 export declare const parseText: ParseFunction<TextMessageEvent>;
+export declare const parsePostback: ParseFunction<PostbackMessageEvent>;
 export declare const parseMedia: ParseFunction<AudioMessageEvent | DocumentMessageEvent | ImageMessageEvent | VideoMessageEvent>;
 export declare const parseLocation: ParseFunction<LocationMessageEvent>;
 export declare const parseElement: (element: any) => CarouselElement;

package/lib/{output-parser → cjs/output-parser}/parsers.js

@@ -1,34 +1,38 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseCustom = exports.parseCarousel = exports.parseElement = exports.parseLocation = exports.parseMedia = exports.parseText = exports.parseReplies = exports.parseReply = exports.parseButtons = exports.parseButton = exports.parseMessage = void 0;
-const _1 = require(".");
-const util_1 = require("./util");
+exports.parseCustom = exports.parseCarousel = exports.parseElement = exports.parseLocation = exports.parseMedia = exports.parsePostback = exports.parseText = exports.parseReplies = exports.parseReply = exports.parseButtons = exports.parseButton = exports.parseMessage = exports.parseBoolean = exports.parseNumber = void 0;
+const models_1 = require("../models");
+const botonic_output_parser_1 = require("./botonic-output-parser");
+function parseNumber(strNumber) {
+    return parseInt(strNumber);
+}
+exports.parseNumber = parseNumber;
+function parseBoolean(strNumber) {
+    if (strNumber === '0')
+        return false;
+    return true;
+}
+exports.parseBoolean = parseBoolean;
 // COMMON
 const parseMessage = args => {
     const typingAndDelay = {};
     if (args.toParse.delay !== undefined) {
-        typingAndDelay['delay'] = util_1.parseNumber(args.toParse.delay);
+        typingAndDelay['delay'] = parseNumber(args.toParse.delay);
     }
     if (args.toParse.typing !== undefined) {
-        typingAndDelay['typing'] = util_1.parseNumber(args.toParse.typing);
+        typingAndDelay['typing'] = parseNumber(args.toParse.typing);
     }
     return {
         toParse: args.toParse,
         parsed: Object.assign({ 
-            // TODO: How to define here the ids?
-            // eventId: '',
-            // userId: '',
-            // createdAt: '',
-            // from: args.toParse.from,
-            // ack: args.toParse.ack,
-            // eventType: EventTypes.MESSAGE,
-            type: args.toParse.type }, typingAndDelay),
+            // Following properties added later before saving event: eventId, userId, createdAt, from, ack
+            eventType: models_1.EventTypes.MESSAGE, type: args.toParse.type, ack: args.toParse.ack, from: args.toParse.from, channel: args.toParse.channel, idFromChannel: args.toParse.idFromChannel }, typingAndDelay),
     };
 };
 exports.parseMessage = parseMessage;
 // BUTTONS
 const parseButton = (button) => {
-    const title = button[_1.TEXT_NODE_NAME];
+    const title = button[botonic_output_parser_1.TEXT_NODE_NAME];
     if ('payload' in button) {
         return { title, payload: button.payload };
     }
@@ -50,33 +54,33 @@ const parseButton = (button) => {
 exports.parseButton = parseButton;
 const parseButtons = args => {
     var _a, _b;
-    const parsed = args.parsed;
     const hasButtons = ((_b = (_a = args.toParse) === null || _a === void 0 ? void 0 : _a.button) === null || _b === void 0 ? void 0 : _b.length) > 0;
+    let buttons = [];
     if (hasButtons) {
-        parsed.buttons = args.toParse.button.map(button => exports.parseButton(button));
+        buttons = args.toParse.button.map(button => exports.parseButton(button));
     }
     return {
         toParse: args.toParse,
-        parsed,
+        parsed: Object.assign(Object.assign({}, args.parsed), { buttons }),
     };
 };
 exports.parseButtons = parseButtons;
 // REPLIES
 const parseReply = (reply) => ({
-    title: reply[_1.TEXT_NODE_NAME],
+    title: reply[botonic_output_parser_1.TEXT_NODE_NAME],
     payload: reply.payload,
 });
 exports.parseReply = parseReply;
 const parseReplies = args => {
     var _a, _b;
-    const parsed = args.parsed;
     const hasReplies = ((_b = (_a = args.toParse) === null || _a === void 0 ? void 0 : _a.reply) === null || _b === void 0 ? void 0 : _b.length) > 0;
+    let replies = [];
     if (hasReplies) {
-        parsed.replies = args.toParse.reply.map(reply => exports.parseReply(reply));
+        replies = args.toParse.reply.map(reply => exports.parseReply(reply));
     }
     return {
         toParse: args.toParse,
-        parsed,
+        parsed: Object.assign(Object.assign({}, args.parsed), { replies }),
     };
 };
 exports.parseReplies = parseReplies;
@@ -84,15 +88,23 @@ exports.parseReplies = parseReplies;
 const parseText = args => {
     return {
         toParse: args.toParse,
-        parsed: Object.assign(Object.assign({}, args.parsed), { text: args.toParse[_1.TEXT_NODE_NAME] || args.toParse.data, markdown: util_1.parseBoolean(args.toParse.markdown) }),
+        parsed: Object.assign(Object.assign({}, args.parsed), { text: args.toParse[botonic_output_parser_1.TEXT_NODE_NAME], markdown: parseBoolean(args.toParse.markdown) }),
     };
 };
 exports.parseText = parseText;
+// POSTBACK
+const parsePostback = args => {
+    return {
+        toParse: args.toParse,
+        parsed: Object.assign(Object.assign({}, args.parsed), { payload: args.toParse.payload }),
+    };
+};
+exports.parsePostback = parsePostback;
 // MEDIA
 const parseMedia = args => {
     return {
         toParse: args.toParse,
-        parsed: Object.assign(Object.assign({}, args.parsed), { src: args.toParse.src || args.toParse.data }),
+        parsed: Object.assign(Object.assign({}, args.parsed), { src: args.toParse.src }),
     };
 };
 exports.parseMedia = parseMedia;
@@ -106,12 +118,15 @@ const parseLocation = args => {
 exports.parseLocation = parseLocation;
 // CAROUSEL
 const parseElement = (element) => {
-    return {
+    const e = {
         pic: element.pic,
         title: element.title,
         subtitle: element.desc,
-        buttons: element.button.map(b => exports.parseButton(b)),
     };
+    const hasButtons = element.button !== undefined;
+    if (hasButtons)
+        e.buttons = element.button.map(b => exports.parseButton(b));
+    return e;
 };
 exports.parseElement = parseElement;
 const parseCarousel = args => {
@@ -125,7 +140,7 @@ exports.parseCarousel = parseCarousel;
 const parseCustom = args => {
     return {
         toParse: args.toParse,
-        parsed: Object.assign(Object.assign({}, args.parsed), { customTypeName: JSON.parse(args.toParse.json).customTypeName }),
+        parsed: Object.assign(Object.assign({}, args.parsed), { json: JSON.parse(args.toParse.json) }),
     };
 };
 exports.parseCustom = parseCustom;

package/lib/cjs/output-parser/parsers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parsers.js","sourceRoot":"","sources":["../../../src/output-parser/parsers.ts"],"names":[],"mappings":";;;AAAA,sCAiBkB;AAClB,mEAAwD;AAExD,SAAgB,WAAW,CAAC,SAAiB;IAC3C,OAAO,QAAQ,CAAC,SAAS,CAAC,CAAA;AAC5B,CAAC;AAFD,kCAEC;AAED,SAAgB,YAAY,CAAC,SAAiB;IAC5C,IAAI,SAAS,KAAK,GAAG;QAAE,OAAO,KAAK,CAAA;IACnC,OAAO,IAAI,CAAA;AACb,CAAC;AAHD,oCAGC;AAUD,SAAS;AACF,MAAM,YAAY,GAAuC,IAAI,CAAC,EAAE;IACrE,MAAM,cAAc,GAAG,EAAE,CAAA;IACzB,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE;QACpC,cAAc,CAAC,OAAO,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;KAC1D;IACD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE;QACrC,cAAc,CAAC,QAAQ,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;KAC5D;IACD,OAAO;QACL,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,MAAM;YACJ,8FAA8F;YAC9F,SAAS,EAAE,mBAAU,CAAC,OAAO,EAC7B,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EACvB,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,EACrB,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EACvB,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,EAC7B,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa,IACtC,cAAc,CAClB;KACF,CAAA;AACH,CAAC,CAAA;AArBY,QAAA,YAAY,gBAqBxB;AAED,UAAU;AACH,MAAM,WAAW,GAAG,CAAC,MAAW,EAAU,EAAE;IACjD,MAAM,KAAK,GAAG,MAAM,CAAC,sCAAc,CAAC,CAAA;IACpC,IAAI,SAAS,IAAI,MAAM,EAAE;QACvB,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAA;KAC1C;IACD,IAAI,KAAK,IAAI,MAAM,EAAE;QACnB,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAA;QAC3D,IAAI,MAAM,CAAC,MAAM;YAAE,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;QAC3C,OAAO,CAAC,CAAA;KACT;IACD,IAAI,SAAS,IAAI,MAAM,EAAE;QACvB,OAAO;YACL,KAAK;YACL,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,MAAM,EAAE,MAAM,CAAC,MAAM;SACtB,CAAA;KACF;IACD,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAA;AAC1C,CAAC,CAAA;AAlBY,QAAA,WAAW,eAkBvB;AAEM,MAAM,YAAY,GAA+B,IAAI,CAAC,EAAE;;IAC7D,MAAM,UAAU,GAAG,CAAA,MAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,MAAM,0CAAE,MAAM,IAAG,CAAC,CAAA;IACnD,IAAI,OAAO,GAAa,EAAE,CAAA;IAC1B,IAAI,UAAU,EAAE;QACd,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,mBAAW,CAAC,MAAM,CAAC,CAAC,CAAA;KACjE;IACD,OAAO;QACL,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,MAAM,kCACD,IAAI,CAAC,MAAM,KACd,OAAO,GACR;KACF,CAAA;AACH,CAAC,CAAA;AAbY,QAAA,YAAY,gBAaxB;AAED,UAAU;AACH,MAAM,UAAU,GAAG,CAAC,KAAU,EAAS,EAAE,CAAC,CAAC;IAChD,KAAK,EAAE,KAAK,CAAC,sCAAc,CAAC;IAC5B,OAAO,EAAE,KAAK,CAAC,OAAO;CACvB,CAAC,CAAA;AAHW,QAAA,UAAU,cAGrB;AAEK,MAAM,YAAY,GAA+B,IAAI,CAAC,EAAE;;IAC7D,MAAM,UAAU,GAAG,CAAA,MAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,KAAK,0CAAE,MAAM,IAAG,CAAC,CAAA;IAClD,IAAI,OAAO,GAAY,EAAE,CAAA;IACzB,IAAI,UAAU,EAAE;QACd,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,kBAAU,CAAC,KAAK,CAAC,CAAC,CAAA;KAC7D;IACD,OAAO;QACL,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,MAAM,kCACD,IAAI,CAAC,MAAM,KACd,OAAO,GACR;KACF,CAAA;AACH,CAAC,CAAA;AAbY,QAAA,YAAY,gBAaxB;AAED,OAAO;AACA,MAAM,SAAS,GAAoC,IAAI,CAAC,EAAE;IAC/D,OAAO;QACL,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,MAAM,kCACD,IAAI,CAAC,MAAM,KACd,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,sCAAc,CAAC,EAClC,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAC9C;KACF,CAAA;AACH,CAAC,CAAA;AATY,QAAA,SAAS,aASrB;AAED,WAAW;AAEJ,MAAM,aAAa,GAAwC,IAAI,CAAC,EAAE;IACvE,OAAO;QACL,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,MAAM,kCACD,IAAI,CAAC,MAAM,KACd,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,GAC9B;KACF,CAAA;AACH,CAAC,CAAA;AARY,QAAA,aAAa,iBAQzB;AAED,QAAQ;AACD,MAAM,UAAU,GAKnB,IAAI,CAAC,EAAE;IACT,OAAO;QACL,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,MAAM,kCACD,IAAI,CAAC,MAAM,KACd,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,GACtB;KACF,CAAA;AACH,CAAC,CAAA;AAbY,QAAA,UAAU,cAatB;AAED,WAAW;AACJ,MAAM,aAAa,GAAwC,IAAI,CAAC,EAAE;IACvE,OAAO;QACL,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,MAAM,kCACD,IAAI,CAAC,MAAM,KACd,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,EACrB,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,GACxB;KACF,CAAA;AACH,CAAC,CAAA;AATY,QAAA,aAAa,iBASzB;AAED,WAAW;AACJ,MAAM,YAAY,GAAG,CAAC,OAAY,EAAmB,EAAE;IAC5D,MAAM,CAAC,GAAoB;QACzB,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,QAAQ,EAAE,OAAO,CAAC,IAAI;KACvB,CAAA;IACD,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,KAAK,SAAS,CAAA;IAC/C,IAAI,UAAU;QAAE,CAAC,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,mBAAW,CAAC,CAAC,CAAC,CAAC,CAAA;IACnE,OAAO,CAAC,CAAA;AACV,CAAC,CAAA;AATY,QAAA,YAAY,gBASxB;AAEM,MAAM,aAAa,GAAwC,IAAI,CAAC,EAAE;IACvE,OAAO;QACL,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,MAAM,kCACD,IAAI,CAAC,MAAM,KACd,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,oBAAY,CAAC,OAAO,CAAC,CAAC,GACrE;KACF,CAAA;AACH,CAAC,CAAA;AARY,QAAA,aAAa,iBAQzB;AAED,SAAS;AACF,MAAM,WAAW,GAAsC,IAAI,CAAC,EAAE;IACnE,OAAO;QACL,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,MAAM,kCACD,IAAI,CAAC,MAAM,KACd,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GACpC;KACF,CAAA;AACH,CAAC,CAAA;AARY,QAAA,WAAW,eAQvB"}

package/lib/cjs/plugins.d.ts

@@ -0,0 +1,6 @@
+import { BotonicEvent, BotState, Input, PluginConfig, Session } from './models';
+declare type PluginMode = 'pre' | 'post';
+export declare function loadPlugins(plugins: PluginConfig<any>[]): any;
+export declare function runPlugins(plugins: any, // // TODO: Add type for resolvedPlugins, they differ from loaded plugins
+mode: PluginMode, input: Input, session: Session, botState: BotState, response?: string | null, messageEvents?: Partial<BotonicEvent>[] | null, dataProvider?: any): Promise<void>;
+export {};

package/lib/{plugins.js → cjs/plugins.js}

@@ -20,19 +20,23 @@ function loadPlugins(plugins) {
     return _plugins;
 }
 exports.loadPlugins = loadPlugins;
-async function runPlugins(plugins, mode, input, session, lastRoutePath, response = null, parsedResponse = null) {
+async function runPlugins(plugins, // // TODO: Add type for resolvedPlugins, they differ from loaded plugins
+mode, input, session, botState, response = null, messageEvents = null, dataProvider // TODO: type as dataProvider
+) {
     for (const key in plugins) {
         const p = await plugins[key];
         try {
-            if (mode == 'pre')
-                await p.pre({ input, session, lastRoutePath });
-            if (mode == 'post')
+            if (mode === 'pre')
+                await p.pre({ input, session, botState, dataProvider, plugins });
+            if (mode === 'post')
                 await p.post({
                     input,
                     session,
-                    lastRoutePath,
+                    botState,
                     response,
-                    parsedResponse,
+                    messageEvents,
+                    dataProvider,
+                    plugins,
                 });
         }
         catch (e) {

package/lib/cjs/plugins.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugins.js","sourceRoot":"","sources":["../../src/plugins.ts"],"names":[],"mappings":";;;AAWA,SAAgB,WAAW,CAAC,OAA4B;IACtD,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,CAAA;IACvB,MAAM,QAAQ,GAAG,EAAE,CAAA;IACnB,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,CAAA;IACpC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,EAAE,CAAC,EAAE,EAAE;QACtC,MAAM,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;QACzC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;QAClC,MAAM,MAAM,GAAG,cAAc,CAAC,OAAO,CAAA;QACrC,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,CAAA;QACpC,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,CAAA;QAC1D,QAAQ,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAA;QACvB,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAA;QACpB,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,GAAG,OAAO,CAAA;QAC7B,QAAQ,CAAC,EAAE,CAAC,CAAC,IAAI,GAAG,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,CAAA;KACnD;IACD,OAAO,QAAQ,CAAA;AACjB,CAAC;AAhBD,kCAgBC;AAEM,KAAK,UAAU,UAAU,CAC9B,OAAY,EAAE,yEAAyE;AACvF,IAAgB,EAChB,KAAY,EACZ,OAAgB,EAChB,QAAkB,EAClB,WAA0B,IAAI,EAC9B,gBAAgD,IAAI,EACpD,YAAkB,CAAC,6BAA6B;;IAEhD,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE;QACzB,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAA;QAC5B,IAAI;YACF,IAAI,IAAI,KAAK,KAAK;gBAChB,MAAM,CAAC,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CAAA;YAClE,IAAI,IAAI,KAAK,MAAM;gBACjB,MAAM,CAAC,CAAC,IAAI,CAAC;oBACX,KAAK;oBACL,OAAO;oBACP,QAAQ;oBACR,QAAQ;oBACR,aAAa;oBACb,YAAY;oBACZ,OAAO;iBACR,CAAC,CAAA;SACL;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;SACf;KACF;AACH,CAAC;AA7BD,gCA6BC"}

package/lib/cjs/routing/index.d.ts

@@ -0,0 +1,2 @@
+export * from './router';
+export * from './router-utils';

package/lib/cjs/routing/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./router"), exports);
+tslib_1.__exportStar(require("./router-utils"), exports);
+//# sourceMappingURL=index.js.map

package/lib/cjs/routing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/routing/index.ts"],"names":[],"mappings":";;;AAAA,mDAAwB;AACxB,yDAA8B"}

package/lib/cjs/routing/router-utils.d.ts

@@ -0,0 +1,11 @@
+import { Action, BotRequest, Input, Params, PathParams, Route, Routes } from '../models';
+export declare class NoMatchingRouteError extends Error {
+    input: Input;
+    constructor(input: Input);
+}
+export declare function isPathPayload(payload?: string): boolean;
+export declare function getPathParamsFromPathPayload(payload?: string): PathParams;
+export declare function pathParamsToParams(pathParams?: string): Params;
+export declare function getEmptyAction(childRoutes?: Route[]): Action;
+export declare function getNotFoundAction(input: Input, routes: Route[]): Action;
+export declare function getComputedRoutes(routes: Routes, request: BotRequest): Promise<Route[]>;

package/lib/cjs/routing/router-utils.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getComputedRoutes = exports.getNotFoundAction = exports.getEmptyAction = exports.pathParamsToParams = exports.getPathParamsFromPathPayload = exports.isPathPayload = exports.NoMatchingRouteError = void 0;
+const constants_1 = require("../constants");
+class NoMatchingRouteError extends Error {
+    constructor(input) {
+        super(`No route found for input '${JSON.stringify(input)}' and no ${constants_1.NOT_FOUND_PATH} route defined`);
+        this.input = input;
+    }
+}
+exports.NoMatchingRouteError = NoMatchingRouteError;
+function isPathPayload(payload) {
+    if (!payload)
+        return false;
+    const isPathPayload = constants_1.PATH_PAYLOAD_REGEXP.exec(payload);
+    return Boolean(isPathPayload);
+}
+exports.isPathPayload = isPathPayload;
+function getPathParamsFromPathPayload(payload) {
+    const defaultPathParams = {
+        path: null,
+        params: {},
+    };
+    if (!payload)
+        return defaultPathParams;
+    if (!isPathPayload(payload))
+        return defaultPathParams;
+    try {
+        const pathWithParams = payload.split(constants_1.PATH_PAYLOAD_IDENTIFIER)[1];
+        if (!pathWithParams) {
+            throw `${constants_1.PATH_PAYLOAD_IDENTIFIER} is empty`;
+        }
+        const [path, params] = pathWithParams.split('?');
+        return { path: path !== null && path !== void 0 ? path : null, params: pathParamsToParams(params) };
+    }
+    catch (e) {
+        console.error('Error getting path and params from input.payload:', e);
+        return defaultPathParams;
+    }
+}
+exports.getPathParamsFromPathPayload = getPathParamsFromPathPayload;
+function pathParamsToParams(pathParams) {
+    if (!pathParams)
+        return {};
+    try {
+        const params = {};
+        const searchParams = new URLSearchParams(pathParams);
+        for (const [key, value] of searchParams) {
+            params[key] = value;
+        }
+        return params;
+    }
+    catch (e) {
+        return {};
+    }
+}
+exports.pathParamsToParams = pathParamsToParams;
+function getEmptyAction(childRoutes) {
+    if (!childRoutes)
+        return null;
+    const emptyActionRoute = childRoutes.find(r => r.path === constants_1.EMPTY_ACTION_PATH);
+    if (!emptyActionRoute)
+        return null;
+    return emptyActionRoute.action;
+}
+exports.getEmptyAction = getEmptyAction;
+function getNotFoundAction(input, routes) {
+    const notFoundActionRoute = routes.find(r => r.path === constants_1.NOT_FOUND_PATH);
+    if (!notFoundActionRoute)
+        throw new NoMatchingRouteError(input);
+    return notFoundActionRoute.action;
+}
+exports.getNotFoundAction = getNotFoundAction;
+async function getComputedRoutes(routes, request) {
+    if (routes instanceof Function) {
+        return await getComputedRoutes(await routes(request), request);
+    }
+    for (const [key, route] of Object.entries(routes)) {
+        if (route.childRoutes && route.childRoutes instanceof Function) {
+            routes[key].childRoutes = await getComputedRoutes(await route.childRoutes(request), request);
+        }
+        else {
+            routes[key] = route;
+        }
+    }
+    return routes;
+}
+exports.getComputedRoutes = getComputedRoutes;
+//# sourceMappingURL=router-utils.js.map

package/lib/cjs/routing/router-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"router-utils.js","sourceRoot":"","sources":["../../../src/routing/router-utils.ts"],"names":[],"mappings":";;;AAAA,4CAKqB;AAWrB,MAAa,oBAAqB,SAAQ,KAAK;IAE7C,YAAY,KAAY;QACtB,KAAK,CACH,6BAA6B,IAAI,CAAC,SAAS,CACzC,KAAK,CACN,YAAY,0BAAc,gBAAgB,CAC5C,CAAA;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;CACF;AAVD,oDAUC;AAED,SAAgB,aAAa,CAAC,OAAgB;IAC5C,IAAI,CAAC,OAAO;QAAE,OAAO,KAAK,CAAA;IAC1B,MAAM,aAAa,GAAG,+BAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACvD,OAAO,OAAO,CAAC,aAAa,CAAC,CAAA;AAC/B,CAAC;AAJD,sCAIC;AAED,SAAgB,4BAA4B,CAAC,OAAgB;IAC3D,MAAM,iBAAiB,GAAG;QACxB,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,EAAE;KACX,CAAA;IACD,IAAI,CAAC,OAAO;QAAE,OAAO,iBAAiB,CAAA;IACtC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;QAAE,OAAO,iBAAiB,CAAA;IACrD,IAAI;QACF,MAAM,cAAc,GAAG,OAAO,CAAC,KAAK,CAAC,mCAAuB,CAAC,CAAC,CAAC,CAAC,CAAA;QAChE,IAAI,CAAC,cAAc,EAAE;YACnB,MAAM,GAAG,mCAAuB,WAAW,CAAA;SAC5C;QACD,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAChD,OAAO,EAAE,IAAI,EAAE,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,IAAI,EAAE,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAA;KAClE;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,CAAC,KAAK,CAAC,mDAAmD,EAAE,CAAC,CAAC,CAAA;QACrE,OAAO,iBAAiB,CAAA;KACzB;AACH,CAAC;AAlBD,oEAkBC;AAED,SAAgB,kBAAkB,CAAC,UAAmB;IACpD,IAAI,CAAC,UAAU;QAAE,OAAO,EAAE,CAAA;IAC1B,IAAI;QACF,MAAM,MAAM,GAAG,EAAE,CAAA;QACjB,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,UAAU,CAAC,CAAA;QACpD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,YAAY,EAAE;YACvC,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;SACpB;QACD,OAAO,MAAM,CAAA;KACd;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,EAAE,CAAA;KACV;AACH,CAAC;AAZD,gDAYC;AAED,SAAgB,cAAc,CAAC,WAAqB;IAClD,IAAI,CAAC,WAAW;QAAE,OAAO,IAAI,CAAA;IAC7B,MAAM,gBAAgB,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,6BAAiB,CAAC,CAAA;IAC5E,IAAI,CAAC,gBAAgB;QAAE,OAAO,IAAI,CAAA;IAClC,OAAO,gBAAgB,CAAC,MAAM,CAAA;AAChC,CAAC;AALD,wCAKC;AAED,SAAgB,iBAAiB,CAAC,KAAY,EAAE,MAAe;IAC7D,MAAM,mBAAmB,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,0BAAc,CAAC,CAAA;IACvE,IAAI,CAAC,mBAAmB;QAAE,MAAM,IAAI,oBAAoB,CAAC,KAAK,CAAC,CAAA;IAC/D,OAAO,mBAAmB,CAAC,MAAM,CAAA;AACnC,CAAC;AAJD,8CAIC;AAEM,KAAK,UAAU,iBAAiB,CACrC,MAAc,EACd,OAAmB;IAEnB,IAAI,MAAM,YAAY,QAAQ,EAAE;QAC9B,OAAO,MAAM,iBAAiB,CAAC,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAA;KAC/D;IACD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAQ,EAAE;QACxD,IAAI,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC,WAAW,YAAY,QAAQ,EAAE;YAC9D,MAAM,CAAC,GAAG,CAAC,CAAC,WAAW,GAAG,MAAM,iBAAiB,CAC/C,MAAM,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,EAChC,OAAO,CACR,CAAA;SACF;aAAM;YACL,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;SACpB;KACF;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAlBD,8CAkBC"}

package/lib/cjs/routing/router.d.ts

@@ -0,0 +1,54 @@
+import { RouteInspector } from '../debug/inspector';
+import { BotState, Input, MatchedValue, Matcher, MatchingProp, Nullable, ProcessInputResult, Route, RouteParams, RoutePath, RoutingState, Session } from '../models';
+export declare class Router {
+    routes: Route[];
+    routeInspector: RouteInspector;
+    constructor(routes: Route[], routeInspector?: RouteInspector | undefined);
+    /**
+     * Processes an input and return a representation of the new bot state.
+     * The algorithm is splitted in two main parts:
+     * 1. Getting the current routing state.
+     * 2. Given a routing state, resolve the different possible scenarios and return the new bot state.
+     * The new bot state can return three type of actions:
+     * - action: an action directly resolved from a matching route
+     * - emptyAction: optional action that can exists or not only within childRoutes
+     * - fallbackAction: any other action that acts as a fallback (404, )
+     */
+    processInput(input: Input, session: Session, botState: BotState): ProcessInputResult;
+    /**
+     * Find the route that matches the given input, if it match with some of the entries, return the whole Route of the entry with optional params captured if matcher was a regex.
+     * IMPORTANT: It returns a cloned route instead of the route itself to avoid modifying original routes and introduce side effects
+     * */
+    getRoute(input: Input | Partial<Input>, routes: Route[], session: Session, lastRoutePath: RoutePath): RouteParams | null;
+    /**
+     * Find the route that matches the given path. Path can include concatenations, e.g: 'Flow1/Subflow1.1'.
+     * IMPORTANT: It returns a cloned route instead of the route itself to avoid modifying original routes and introduce side effects
+     * */
+    getRouteByPath(path: RoutePath, routeList?: Route[]): Nullable<Route>;
+    /**
+     * Returns the matched value for a specific route.
+     * Matching Props: ('text' | 'payload' | 'intent' | 'type' | 'input' | 'session' | 'request' ...)
+     * Matchers: (string: exact match | regex: regular expression match | function: return true)
+     * input: user input object, e.g.: {type: 'text', data: 'Hi'}
+     * */
+    matchRoute(route: Route, prop: MatchingProp, matcher: Matcher, input: Input, session: Session, lastRoutePath: RoutePath): MatchedValue;
+    /**
+     * Runs the matcher against the given value.
+     * If there is a match, it will return a truthy value (true, RegExp result), o.w., it will return a falsy value.
+     * */
+    matchValue(matcher: Matcher, value: any): MatchedValue;
+    /**
+     * It resolves the current state of navigation. Two scenarios:
+     * 1. Given a path payload input (__PATH_PAYLOAD__somePath?someParam=someValue), we can resolve the routing state directly from it (using getRouteByPath).
+     * 2. Given any other type of input, we resolve the routing state with normal resolution (using getRoute).
+     * */
+    getRoutingState(input: Input, session: Session, botState: BotState): RoutingState;
+    /**
+     * Given a non path payload input, try to run it against the routes, update matching routes information in consequence and dictamine if the flow has been broken.
+     * */
+    getRoutingStateFromInput(currentRoute: Nullable<Route>, input: Input, session: Session): RoutingState;
+    /**
+     * Given a path payload input, try to run the path against the routes, update matching routes information in consequence and dictamine if the flow has been broken.
+     * */
+    getRoutingStateFromPathPayload(currentRoute: Nullable<Route>, pathPayload: string): RoutingState;
+}