@botonic/core 0.19.0 → 0.20.2-alpha.0

package/lib/esm/output-parser/parsers.js

@@ -0,0 +1,130 @@
+import { EventTypes, } from '../models';
+import { TEXT_NODE_NAME } from './botonic-output-parser';
+export function parseNumber(strNumber) {
+    return parseInt(strNumber);
+}
+export function parseBoolean(strNumber) {
+    if (strNumber === '0')
+        return false;
+    return true;
+}
+// COMMON
+export const parseMessage = args => {
+    const typingAndDelay = {};
+    if (args.toParse.delay !== undefined) {
+        typingAndDelay['delay'] = parseNumber(args.toParse.delay);
+    }
+    if (args.toParse.typing !== undefined) {
+        typingAndDelay['typing'] = parseNumber(args.toParse.typing);
+    }
+    return {
+        toParse: args.toParse,
+        parsed: Object.assign({ 
+            // Following properties added later before saving event: eventId, userId, createdAt, from, ack
+            eventType: EventTypes.MESSAGE, type: args.toParse.type, ack: args.toParse.ack, from: args.toParse.from }, typingAndDelay),
+    };
+};
+// BUTTONS
+export const parseButton = (button) => {
+    const title = button[TEXT_NODE_NAME];
+    if ('payload' in button) {
+        return { title, payload: button.payload };
+    }
+    if ('url' in button) {
+        const b = { title, url: button.url, target: button.target };
+        if (button.target)
+            b.target = button.target;
+        return b;
+    }
+    if ('webview' in button) {
+        return {
+            title,
+            webview: button.webview,
+            params: button.params,
+        };
+    }
+    throw new Error('Invalid parsed Button');
+};
+export const parseButtons = args => {
+    var _a, _b;
+    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) {
+        buttons = args.toParse.button.map(button => parseButton(button));
+    }
+    return {
+        toParse: args.toParse,
+        parsed: Object.assign(Object.assign({}, args.parsed), { buttons }),
+    };
+};
+// REPLIES
+export const parseReply = (reply) => ({
+    title: reply[TEXT_NODE_NAME],
+    payload: reply.payload,
+});
+export const parseReplies = args => {
+    var _a, _b;
+    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) {
+        replies = args.toParse.reply.map(reply => parseReply(reply));
+    }
+    return {
+        toParse: args.toParse,
+        parsed: Object.assign(Object.assign({}, args.parsed), { replies }),
+    };
+};
+// TEXT
+export const parseText = args => {
+    return {
+        toParse: args.toParse,
+        parsed: Object.assign(Object.assign({}, args.parsed), { text: args.toParse[TEXT_NODE_NAME], markdown: parseBoolean(args.toParse.markdown) }),
+    };
+};
+// POSTBACK
+export const parsePostback = args => {
+    return {
+        toParse: args.toParse,
+        parsed: Object.assign(Object.assign({}, args.parsed), { payload: args.toParse.payload }),
+    };
+};
+// MEDIA
+export const parseMedia = args => {
+    return {
+        toParse: args.toParse,
+        parsed: Object.assign(Object.assign({}, args.parsed), { src: args.toParse.src }),
+    };
+};
+// LOCATION
+export const parseLocation = args => {
+    return {
+        toParse: args.toParse,
+        parsed: Object.assign(Object.assign({}, args.parsed), { lat: args.toParse.lat, long: args.toParse.long }),
+    };
+};
+// CAROUSEL
+export const parseElement = (element) => {
+    const e = {
+        pic: element.pic,
+        title: element.title,
+        subtitle: element.desc,
+    };
+    const hasButtons = element.button !== undefined;
+    if (hasButtons)
+        e.buttons = element.button.map(b => parseButton(b));
+    return e;
+};
+export const parseCarousel = args => {
+    return {
+        toParse: args.toParse,
+        parsed: Object.assign(Object.assign({}, args.parsed), { elements: args.toParse.element.map(element => parseElement(element)) }),
+    };
+};
+// CUSTOM
+export const parseCustom = args => {
+    return {
+        toParse: args.toParse,
+        parsed: Object.assign(Object.assign({}, args.parsed), { json: JSON.parse(args.toParse.json) }),
+    };
+};
+//# sourceMappingURL=parsers.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"parsers.js","sourceRoot":"","sources":["../../../src/output-parser/parsers.ts"],"names":[],"mappings":"AAAA,OAAO,EAQL,UAAU,GASX,MAAM,WAAW,CAAA;AAClB,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AAExD,MAAM,UAAU,WAAW,CAAC,SAAiB;IAC3C,OAAO,QAAQ,CAAC,SAAS,CAAC,CAAA;AAC5B,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,SAAiB;IAC5C,IAAI,SAAS,KAAK,GAAG;QAAE,OAAO,KAAK,CAAA;IACnC,OAAO,IAAI,CAAA;AACb,CAAC;AAUD,SAAS;AACT,MAAM,CAAC,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,UAAU,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,IACpB,cAAc,CAClB;KACF,CAAA;AACH,CAAC,CAAA;AAED,UAAU;AACV,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,MAAW,EAAU,EAAE;IACjD,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,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;AAED,MAAM,CAAC,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,WAAW,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;AAED,UAAU;AACV,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAU,EAAS,EAAE,CAAC,CAAC;IAChD,KAAK,EAAE,KAAK,CAAC,cAAc,CAAC;IAC5B,OAAO,EAAE,KAAK,CAAC,OAAO;CACvB,CAAC,CAAA;AAEF,MAAM,CAAC,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,UAAU,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;AAED,OAAO;AACP,MAAM,CAAC,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,cAAc,CAAC,EAClC,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAC9C;KACF,CAAA;AACH,CAAC,CAAA;AAED,WAAW;AAEX,MAAM,CAAC,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;AAED,QAAQ;AACR,MAAM,CAAC,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;AAED,WAAW;AACX,MAAM,CAAC,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;AAED,WAAW;AACX,MAAM,CAAC,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,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;IACnE,OAAO,CAAC,CAAA;AACV,CAAC,CAAA;AAED,MAAM,CAAC,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,YAAY,CAAC,OAAO,CAAC,CAAC,GACrE;KACF,CAAA;AACH,CAAC,CAAA;AAED,SAAS;AACT,MAAM,CAAC,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"}

package/lib/esm/plugins.d.ts

@@ -0,0 +1,7 @@
+import { DataProvider } from './data-provider';
+import { BotonicEvent, Input, PluginConfig, RoutePath, 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, lastRoutePath: RoutePath, response?: string | null, messageEvents?: Partial<BotonicEvent>[] | null, dataProvider?: DataProvider): Promise<void>;
+export {};

package/lib/esm/plugins.js

@@ -0,0 +1,42 @@
+export function loadPlugins(plugins) {
+    if (!plugins)
+        return [];
+    const _plugins = {};
+    const pluginsLength = plugins.length;
+    for (let i = 0; i < pluginsLength; i++) {
+        const pluginRequired = plugins[i].resolve;
+        const options = plugins[i].options;
+        const Plugin = pluginRequired.default;
+        const instance = new Plugin(options);
+        const id = plugins[i].id || `${instance.constructor.name}`;
+        _plugins[id] = instance;
+        _plugins[id].id = id;
+        _plugins[id].config = options;
+        _plugins[id].name = `${instance.constructor.name}`;
+    }
+    return _plugins;
+}
+export async function runPlugins(plugins, // // TODO: Add type for resolvedPlugins, they differ from loaded plugins
+mode, input, session, lastRoutePath, response = null, messageEvents = null, dataProvider) {
+    for (const key in plugins) {
+        const p = await plugins[key];
+        try {
+            if (mode === 'pre')
+                await p.pre({ input, session, lastRoutePath, dataProvider, plugins });
+            if (mode === 'post')
+                await p.post({
+                    input,
+                    session,
+                    lastRoutePath,
+                    response,
+                    messageEvents,
+                    dataProvider,
+                    plugins,
+                });
+        }
+        catch (e) {
+            console.log(e);
+        }
+    }
+}
+//# sourceMappingURL=plugins.js.map

package/lib/esm/plugins.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugins.js","sourceRoot":"","sources":["../../src/plugins.ts"],"names":[],"mappings":"AAKA,MAAM,UAAU,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;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,OAAY,EAAE,yEAAyE;AACvF,IAAgB,EAChB,KAAY,EACZ,OAAgB,EAChB,aAAwB,EACxB,WAA0B,IAAI,EAC9B,gBAAgD,IAAI,EACpD,YAA2B;IAE3B,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,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CAAA;YACvE,IAAI,IAAI,KAAK,MAAM;gBACjB,MAAM,CAAC,CAAC,IAAI,CAAC;oBACX,KAAK;oBACL,OAAO;oBACP,aAAa;oBACb,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"}

package/lib/esm/pusher-utils.d.ts

@@ -0,0 +1,7 @@
+/**
+ *
+ * @param compressedData a string representing gzipped data previously encoded to base64 for very large contents
+ * @returns a string representing the information of a very large content
+ * Ref: https://stackoverflow.com/questions/4875020/javascript-decompress-inflate-unzip-ungzip-strings (check jsfiddle proposal)
+ */
+export declare function decompressData(compressedData: string): string;

package/lib/esm/pusher-utils.js

@@ -0,0 +1,16 @@
+import { inflate } from 'pako/dist/pako_inflate.js';
+/**
+ *
+ * @param compressedData a string representing gzipped data previously encoded to base64 for very large contents
+ * @returns a string representing the information of a very large content
+ * Ref: https://stackoverflow.com/questions/4875020/javascript-decompress-inflate-unzip-ungzip-strings (check jsfiddle proposal)
+ */
+export function decompressData(compressedData) {
+    const strData = atob(compressedData); // Decode base64 (convert ascii to binary)
+    const charData = strData.split('').map(x => x.charCodeAt(0)); // Convert binary string to character-number array
+    const binData = new Uint8Array(charData); // Turn number array into byte-array
+    const data = inflate(binData);
+    // @ts-ignore
+    return String.fromCharCode.apply(null, new Uint8Array(data)); // Convert gunzipped byteArray back to ascii string
+}
+//# sourceMappingURL=pusher-utils.js.map

package/lib/esm/pusher-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pusher-utils.js","sourceRoot":"","sources":["../../src/pusher-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAA;AAEnD;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,cAAsB;IACnD,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,CAAA,CAAC,0CAA0C;IAC/E,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA,CAAC,kDAAkD;IAC/G,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,QAAQ,CAAC,CAAA,CAAC,oCAAoC;IAC7E,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAC7B,aAAa;IACb,OAAO,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAA,CAAC,mDAAmD;AAClH,CAAC"}

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

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

package/lib/esm/routing/index.js

@@ -0,0 +1,3 @@
+export * from './router';
+export * from './router-utils';
+//# sourceMappingURL=index.js.map

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

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

package/lib/esm/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/esm/routing/router-utils.js

@@ -0,0 +1,79 @@
+import { EMPTY_ACTION_PATH, NOT_FOUND_PATH, PATH_PAYLOAD_IDENTIFIER, PATH_PAYLOAD_REGEXP, } from '../constants';
+export class NoMatchingRouteError extends Error {
+    constructor(input) {
+        super(`No route found for input '${JSON.stringify(input)}' and no ${NOT_FOUND_PATH} route defined`);
+        this.input = input;
+    }
+}
+export function isPathPayload(payload) {
+    if (!payload)
+        return false;
+    const isPathPayload = PATH_PAYLOAD_REGEXP.exec(payload);
+    return Boolean(isPathPayload);
+}
+export function getPathParamsFromPathPayload(payload) {
+    const defaultPathParams = {
+        path: null,
+        params: {},
+    };
+    if (!payload)
+        return defaultPathParams;
+    if (!isPathPayload(payload))
+        return defaultPathParams;
+    try {
+        const pathWithParams = payload.split(PATH_PAYLOAD_IDENTIFIER)[1];
+        if (!pathWithParams) {
+            throw `${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;
+    }
+}
+export 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 {};
+    }
+}
+export function getEmptyAction(childRoutes) {
+    if (!childRoutes)
+        return null;
+    const emptyActionRoute = childRoutes.find(r => r.path === EMPTY_ACTION_PATH);
+    if (!emptyActionRoute)
+        return null;
+    return emptyActionRoute.action;
+}
+export function getNotFoundAction(input, routes) {
+    const notFoundActionRoute = routes.find(r => r.path === NOT_FOUND_PATH);
+    if (!notFoundActionRoute)
+        throw new NoMatchingRouteError(input);
+    return notFoundActionRoute.action;
+}
+export 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;
+}
+//# sourceMappingURL=router-utils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"router-utils.js","sourceRoot":"","sources":["../../../src/routing/router-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,uBAAuB,EACvB,mBAAmB,GACpB,MAAM,cAAc,CAAA;AAWrB,MAAM,OAAO,oBAAqB,SAAQ,KAAK;IAE7C,YAAY,KAAY;QACtB,KAAK,CACH,6BAA6B,IAAI,CAAC,SAAS,CACzC,KAAK,CACN,YAAY,cAAc,gBAAgB,CAC5C,CAAA;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;CACF;AAED,MAAM,UAAU,aAAa,CAAC,OAAgB;IAC5C,IAAI,CAAC,OAAO;QAAE,OAAO,KAAK,CAAA;IAC1B,MAAM,aAAa,GAAG,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACvD,OAAO,OAAO,CAAC,aAAa,CAAC,CAAA;AAC/B,CAAC;AAED,MAAM,UAAU,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,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAA;QAChE,IAAI,CAAC,cAAc,EAAE;YACnB,MAAM,GAAG,uBAAuB,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;AAED,MAAM,UAAU,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;AAED,MAAM,UAAU,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,iBAAiB,CAAC,CAAA;IAC5E,IAAI,CAAC,gBAAgB;QAAE,OAAO,IAAI,CAAA;IAClC,OAAO,gBAAgB,CAAC,MAAM,CAAA;AAChC,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,KAAY,EAAE,MAAe;IAC7D,MAAM,mBAAmB,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,cAAc,CAAC,CAAA;IACvE,IAAI,CAAC,mBAAmB;QAAE,MAAM,IAAI,oBAAoB,CAAC,KAAK,CAAC,CAAA;IAC/D,OAAO,mBAAmB,CAAC,MAAM,CAAA;AACnC,CAAC;AAED,MAAM,CAAC,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"}

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

@@ -0,0 +1,54 @@
+import { RouteInspector } from '../debug/inspector';
+import { 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, lastRoutePath?: RoutePath): 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, lastRoutePath: RoutePath): 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;
+}