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

package/lib/esm/routing/router.js

@@ -0,0 +1,315 @@
+import { NOT_FOUND_PATH } from '../constants';
+import { RouteInspector } from '../debug/inspector';
+import { cloneObject } from '../utils';
+import { getEmptyAction, getNotFoundAction, getPathParamsFromPathPayload, isPathPayload, } from './router-utils';
+export class Router {
+    constructor(routes, routeInspector = undefined) {
+        this.routes = routes;
+        this.routeInspector = routeInspector || new RouteInspector();
+    }
+    /**
+     * 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, )
+     */
+    // eslint-disable-next-line complexity
+    processInput(input, session, botState) {
+        var _a, _b, _c, _d, _e;
+        botState.retries = (_a = botState.retries) !== null && _a !== void 0 ? _a : 0;
+        // 1. Getting the current routing state.
+        const { currentRoute, matchedRoute, params, isFlowBroken, } = this.getRoutingState(input, session, botState);
+        const currentRoutePath = (_b = currentRoute === null || currentRoute === void 0 ? void 0 : currentRoute.path) !== null && _b !== void 0 ? _b : null;
+        const matchedRoutePath = (_c = matchedRoute === null || matchedRoute === void 0 ? void 0 : matchedRoute.path) !== null && _c !== void 0 ? _c : null;
+        // 2. Given a routing state, resolve the different possible scenarios and return the new bot state.
+        /**
+         * Redirect Scenario:
+         * We have matched a redirect route with a given redirection path, so we try to obtain the redirectionRoute with getRouteByPath.
+         * Independently of whether the redirectionRoute is found or not, the intent is to trigger a redirection which by definition breaks the flow, so retries are set to 0.
+         * It has preference over ignoring retries.
+         */
+        if (matchedRoute && matchedRoute.redirect) {
+            botState.retries = 0;
+            const redirectionRoute = this.getRouteByPath(matchedRoute.redirect);
+            if (redirectionRoute) {
+                botState.lastRoutePath = matchedRoute.redirect;
+                return {
+                    action: redirectionRoute.action,
+                    emptyAction: getEmptyAction(redirectionRoute.childRoutes),
+                    fallbackAction: null,
+                    botState,
+                    params,
+                };
+            }
+            botState.lastRoutePath = null;
+            return {
+                action: null,
+                emptyAction: null,
+                fallbackAction: getNotFoundAction(input, this.routes),
+                botState,
+                params,
+            };
+        }
+        /**
+         * Ignore Retry Scenario:
+         * We have matched a route with an ignore retry, so we return directly the new bot state. The intent is to break the flow, so retries are set to 0.
+         */
+        if (matchedRoute && matchedRoute.ignoreRetry) {
+            botState.retries = 0;
+            botState.lastRoutePath = matchedRoutePath;
+            return {
+                action: matchedRoute.action,
+                emptyAction: getEmptyAction(matchedRoute.childRoutes),
+                fallbackAction: null,
+                botState,
+                params,
+            };
+        }
+        /**
+         * Retry Scenario:
+         * We were in a route which had retries enabled, so we check if the number of retries is exceeded.
+         * If we have not surpassed the limit of retries and we haven't matched an ignoreRetry route, update them, and then return the new bot state.
+         */
+        if (isFlowBroken &&
+            currentRoute &&
+            currentRoute.retry &&
+            botState.retries < currentRoute.retry) {
+            botState.retries = botState.retries !== 0 ? botState.retries + 1 : 1;
+            botState.lastRoutePath = currentRoutePath;
+            if (matchedRoute && matchedRoutePath !== NOT_FOUND_PATH) {
+                return {
+                    action: currentRoute.action,
+                    emptyAction: getEmptyAction(matchedRoute.childRoutes),
+                    fallbackAction: matchedRoute.action,
+                    botState,
+                    params,
+                };
+            }
+            return {
+                action: (_d = currentRoute.action) !== null && _d !== void 0 ? _d : null,
+                emptyAction: getEmptyAction(currentRoute.childRoutes),
+                fallbackAction: getNotFoundAction(input, this.routes),
+                botState,
+                params,
+            };
+        }
+        /**
+         * Default Scenario:
+         * We have matched a route or not, but we don't need to execute retries logic, so retries stay to 0.
+         */
+        botState.retries = 0;
+        /**
+         * Matching Route Scenario:
+         * We have matched a route, so we return the new bot state.
+         */
+        if (matchedRoute && matchedRoutePath !== NOT_FOUND_PATH) {
+            botState.lastRoutePath = matchedRoutePath;
+            return {
+                action: (_e = matchedRoute.action) !== null && _e !== void 0 ? _e : null,
+                emptyAction: getEmptyAction(matchedRoute.childRoutes),
+                fallbackAction: null,
+                botState,
+                params,
+            };
+        }
+        /**
+         * 404 Scenario (No Route Found):
+         * We have not matched any route, so we return the new bot state.
+         */
+        botState.lastRoutePath = currentRoutePath;
+        return {
+            action: null,
+            emptyAction: null,
+            fallbackAction: getNotFoundAction(input, this.routes),
+            params,
+            botState,
+        };
+    }
+    /**
+     * 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, routes, session, lastRoutePath) {
+        let params = {};
+        const route = routes.find(r => Object.entries(r)
+            .filter(([key, _]) => key !== 'action' && key !== 'childRoutes' && key !== 'path')
+            .some(([key, value]) => {
+            const match = this.matchRoute(r, key, value, input, session, lastRoutePath);
+            try {
+                if (match !== null && typeof match !== 'boolean' && match.groups) {
+                    // Strip '[Object: null prototype]' from groups result: https://stackoverflow.com/a/62945609/6237608
+                    params = Object.assign({}, match.groups);
+                }
+            }
+            catch (e) { }
+            return Boolean(match);
+        }));
+        if (route)
+            return { route: cloneObject(route), params };
+        return 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, routeList = this.routes) {
+        if (!path)
+            return null;
+        const [currentPath, ...childPath] = path.split('/');
+        for (const route of routeList) {
+            // iterate over all routeList
+            if (route.path === currentPath) {
+                if (route.childRoutes &&
+                    route.childRoutes.length &&
+                    childPath.length > 0) {
+                    // evaluate childroute over next actions
+                    const computedRoute = this.getRouteByPath(childPath.join('/'), route.childRoutes);
+                    // IMPORTANT: Returning a new object to avoid modifying dev routes and introduce side effects
+                    if (computedRoute)
+                        return cloneObject(computedRoute);
+                }
+                else if (childPath.length === 0) {
+                    return cloneObject(route); // last action and found route
+                }
+            }
+        }
+        return null;
+    }
+    /**
+     * 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, prop, matcher, input, session, lastRoutePath) {
+        let value = null;
+        if (Object.keys(input).indexOf(prop) > -1)
+            value = input[prop];
+        else if (prop === 'input')
+            value = input;
+        else if (prop === 'session')
+            value = session;
+        else if (prop === 'request')
+            value = { input, session, lastRoutePath };
+        const matched = this.matchValue(matcher, value);
+        if (matched) {
+            this.routeInspector.routeMatched(route, prop, matcher, value);
+        }
+        else {
+            this.routeInspector.routeNotMatched(route, prop, matcher, value);
+        }
+        return matched;
+    }
+    /**
+     * 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, value) {
+        if (typeof matcher === 'string')
+            return value === matcher;
+        if (matcher instanceof RegExp) {
+            if (value === undefined || value === null)
+                return false;
+            return matcher.exec(value);
+        }
+        if (typeof matcher === 'function')
+            return matcher(value);
+        return false;
+    }
+    /**
+     * 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, session, botState) {
+        const currentRoute = this.getRouteByPath(botState.lastRoutePath);
+        if (currentRoute && botState.lastRoutePath)
+            currentRoute.path = botState.lastRoutePath;
+        if (typeof input.payload === 'string' && isPathPayload(input.payload)) {
+            return this.getRoutingStateFromPathPayload(currentRoute, input.payload);
+        }
+        return this.getRoutingStateFromInput(currentRoute, input, session);
+    }
+    /**
+     * 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, input, session) {
+        var _a, _b, _c;
+        // get route depending of current ChildRoutes
+        if (currentRoute && currentRoute.childRoutes) {
+            const routeParams = this.getRoute(input, currentRoute.childRoutes, session, currentRoute.path);
+            if (routeParams) {
+                return {
+                    currentRoute,
+                    matchedRoute: Object.assign(Object.assign({}, routeParams.route), { path: routeParams.route && currentRoute.path
+                            ? `${currentRoute.path}/${routeParams.route.path}`
+                            : currentRoute.path }),
+                    params: routeParams.params,
+                    isFlowBroken: false,
+                };
+            }
+        }
+        /**
+         * we couldn't find a route in the state of the currentRoute childRoutes,
+         * so let's find in the general routes
+         */
+        const routeParams = this.getRoute(input, this.routes, session, (_a = currentRoute === null || currentRoute === void 0 ? void 0 : currentRoute.path) !== null && _a !== void 0 ? _a : null);
+        const isFlowBroken = Boolean(currentRoute === null || currentRoute === void 0 ? void 0 : currentRoute.path);
+        if (routeParams === null || routeParams === void 0 ? void 0 : routeParams.route) {
+            return {
+                currentRoute,
+                matchedRoute: Object.assign(Object.assign({}, routeParams.route), { path: (_c = (_b = routeParams.route) === null || _b === void 0 ? void 0 : _b.path) !== null && _c !== void 0 ? _c : null }),
+                params: routeParams.params,
+                isFlowBroken,
+            };
+        }
+        return {
+            currentRoute,
+            matchedRoute: null,
+            params: {},
+            isFlowBroken,
+        };
+    }
+    /**
+     * 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, pathPayload) {
+        const { path, params } = getPathParamsFromPathPayload(pathPayload);
+        /**
+         * shorthand function to update the matching information given a path
+         */
+        const getRoutingStateFromPath = (seekPath) => {
+            const matchedRoute = this.getRouteByPath(seekPath);
+            if (!matchedRoute) {
+                return {
+                    currentRoute,
+                    matchedRoute: null,
+                    params: {},
+                    isFlowBroken: true,
+                };
+            }
+            return {
+                currentRoute,
+                matchedRoute: Object.assign(Object.assign({}, matchedRoute), { path: seekPath }),
+                params,
+                isFlowBroken: false,
+            };
+        };
+        /**
+         * Given a valid path: 'Flow1/Subflow1' we are in one of the two scenarios below.
+         */
+        //  1. Received __PATH_PAYLOAD__Subflow2, so we need to first try to concatenate it with Flow1 (lastRoutePath)
+        if (currentRoute === null || currentRoute === void 0 ? void 0 : currentRoute.path) {
+            const routingState = getRoutingStateFromPath(`${currentRoute.path}/${path}`);
+            if (routingState.matchedRoute)
+                return routingState;
+        }
+        // 2. Received __PATH_PAYLOAD__Flow1/Subflow1, so we can resolve it directly
+        return getRoutingStateFromPath(path);
+    }
+}
+//# sourceMappingURL=router.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"router.js","sourceRoot":"","sources":["../../../src/routing/router.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAenD,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AACtC,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,4BAA4B,EAC5B,aAAa,GACd,MAAM,gBAAgB,CAAA;AAEvB,MAAM,OAAO,MAAM;IAIjB,YACE,MAAe,EACf,iBAA6C,SAAS;QAEtD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,cAAc,GAAG,cAAc,IAAI,IAAI,cAAc,EAAE,CAAA;IAC9D,CAAC;IAED;;;;;;;;;OASG;IAEH,sCAAsC;IACtC,YAAY,CACV,KAAY,EACZ,OAAgB,EAChB,QAAkB;;QAElB,QAAQ,CAAC,OAAO,GAAG,MAAA,QAAQ,CAAC,OAAO,mCAAI,CAAC,CAAA;QAExC,wCAAwC;QACxC,MAAM,EACJ,YAAY,EACZ,YAAY,EACZ,MAAM,EACN,YAAY,GACb,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;QAElD,MAAM,gBAAgB,GAAG,MAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,IAAI,mCAAI,IAAI,CAAA;QACnD,MAAM,gBAAgB,GAAG,MAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,IAAI,mCAAI,IAAI,CAAA;QAEnD,mGAAmG;QAEnG;;;;;WAKG;QACH,IAAI,YAAY,IAAI,YAAY,CAAC,QAAQ,EAAE;YACzC,QAAQ,CAAC,OAAO,GAAG,CAAC,CAAA;YACpB,MAAM,gBAAgB,GAAG,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;YACnE,IAAI,gBAAgB,EAAE;gBACpB,QAAQ,CAAC,aAAa,GAAG,YAAY,CAAC,QAAQ,CAAA;gBAC9C,OAAO;oBACL,MAAM,EAAE,gBAAgB,CAAC,MAAM;oBAC/B,WAAW,EAAE,cAAc,CAAC,gBAAgB,CAAC,WAAW,CAAC;oBACzD,cAAc,EAAE,IAAI;oBACpB,QAAQ;oBACR,MAAM;iBACP,CAAA;aACF;YACD,QAAQ,CAAC,aAAa,GAAG,IAAI,CAAA;YAC7B,OAAO;gBACL,MAAM,EAAE,IAAI;gBACZ,WAAW,EAAE,IAAI;gBACjB,cAAc,EAAE,iBAAiB,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC;gBACrD,QAAQ;gBACR,MAAM;aACP,CAAA;SACF;QAED;;;WAGG;QACH,IAAI,YAAY,IAAI,YAAY,CAAC,WAAW,EAAE;YAC5C,QAAQ,CAAC,OAAO,GAAG,CAAC,CAAA;YACpB,QAAQ,CAAC,aAAa,GAAG,gBAAgB,CAAA;YACzC,OAAO;gBACL,MAAM,EAAE,YAAY,CAAC,MAAM;gBAC3B,WAAW,EAAE,cAAc,CAAC,YAAY,CAAC,WAAW,CAAC;gBACrD,cAAc,EAAE,IAAI;gBACpB,QAAQ;gBACR,MAAM;aACP,CAAA;SACF;QAED;;;;WAIG;QACH,IACE,YAAY;YACZ,YAAY;YACZ,YAAY,CAAC,KAAK;YAClB,QAAQ,CAAC,OAAO,GAAG,YAAY,CAAC,KAAK,EACrC;YACA,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YACpE,QAAQ,CAAC,aAAa,GAAG,gBAAgB,CAAA;YACzC,IAAI,YAAY,IAAI,gBAAgB,KAAK,cAAc,EAAE;gBACvD,OAAO;oBACL,MAAM,EAAE,YAAY,CAAC,MAAM;oBAC3B,WAAW,EAAE,cAAc,CAAC,YAAY,CAAC,WAAW,CAAC;oBACrD,cAAc,EAAE,YAAY,CAAC,MAAM;oBACnC,QAAQ;oBACR,MAAM;iBACP,CAAA;aACF;YACD,OAAO;gBACL,MAAM,EAAE,MAAA,YAAY,CAAC,MAAM,mCAAI,IAAI;gBACnC,WAAW,EAAE,cAAc,CAAC,YAAY,CAAC,WAAW,CAAC;gBACrD,cAAc,EAAE,iBAAiB,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC;gBACrD,QAAQ;gBACR,MAAM;aACP,CAAA;SACF;QAED;;;WAGG;QACH,QAAQ,CAAC,OAAO,GAAG,CAAC,CAAA;QAEpB;;;WAGG;QACH,IAAI,YAAY,IAAI,gBAAgB,KAAK,cAAc,EAAE;YACvD,QAAQ,CAAC,aAAa,GAAG,gBAAgB,CAAA;YACzC,OAAO;gBACL,MAAM,EAAE,MAAA,YAAY,CAAC,MAAM,mCAAI,IAAI;gBACnC,WAAW,EAAE,cAAc,CAAC,YAAY,CAAC,WAAW,CAAC;gBACrD,cAAc,EAAE,IAAI;gBACpB,QAAQ;gBACR,MAAM;aACP,CAAA;SACF;QAED;;;WAGG;QACH,QAAQ,CAAC,aAAa,GAAG,gBAAgB,CAAA;QACzC,OAAO;YACL,MAAM,EAAE,IAAI;YACZ,WAAW,EAAE,IAAI;YACjB,cAAc,EAAE,iBAAiB,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC;YACrD,MAAM;YACN,QAAQ;SACT,CAAA;IACH,CAAC;IAED;;;SAGK;IACL,QAAQ,CACN,KAA6B,EAC7B,MAAe,EACf,OAAgB,EAChB,aAAwB;QAExB,IAAI,MAAM,GAAG,EAAE,CAAA;QACf,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAC5B,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;aACd,MAAM,CACL,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CACX,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,aAAa,IAAI,GAAG,KAAK,MAAM,CAC9D;aACA,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YACrB,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAC3B,CAAC,EACD,GAAmB,EACnB,KAAgB,EAChB,KAAc,EACd,OAAO,EACP,aAAa,CACd,CAAA;YACD,IAAI;gBACF,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,EAAE;oBAChE,oGAAoG;oBACpG,MAAM,qBAAQ,KAAK,CAAC,MAAM,CAAE,CAAA;iBAC7B;aACF;YAAC,OAAO,CAAC,EAAE,GAAE;YACd,OAAO,OAAO,CAAC,KAAK,CAAC,CAAA;QACvB,CAAC,CAAC,CACL,CAAA;QACD,IAAI,KAAK;YAAE,OAAO,EAAE,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;QACvD,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;SAGK;IACL,cAAc,CACZ,IAAe,EACf,YAAqB,IAAI,CAAC,MAAM;QAEhC,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAA;QACtB,MAAM,CAAC,WAAW,EAAE,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACnD,KAAK,MAAM,KAAK,IAAI,SAAS,EAAE;YAC7B,6BAA6B;YAC7B,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE;gBAC9B,IACE,KAAK,CAAC,WAAW;oBACjB,KAAK,CAAC,WAAW,CAAC,MAAM;oBACxB,SAAS,CAAC,MAAM,GAAG,CAAC,EACpB;oBACA,wCAAwC;oBACxC,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CACvC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EACnB,KAAK,CAAC,WAAW,CAClB,CAAA;oBACD,6FAA6F;oBAC7F,IAAI,aAAa;wBAAE,OAAO,WAAW,CAAC,aAAa,CAAC,CAAA;iBACrD;qBAAM,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;oBACjC,OAAO,WAAW,CAAC,KAAK,CAAC,CAAA,CAAC,8BAA8B;iBACzD;aACF;SACF;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;SAKK;IACL,UAAU,CACR,KAAY,EACZ,IAAkB,EAClB,OAAgB,EAChB,KAAY,EACZ,OAAgB,EAChB,aAAwB;QAExB,IAAI,KAAK,GAAQ,IAAI,CAAA;QACrB,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAAE,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAA;aACzD,IAAI,IAAI,KAAK,OAAO;YAAE,KAAK,GAAG,KAAK,CAAA;aACnC,IAAI,IAAI,KAAK,SAAS;YAAE,KAAK,GAAG,OAAO,CAAA;aACvC,IAAI,IAAI,KAAK,SAAS;YAAE,KAAK,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,aAAa,EAAE,CAAA;QACtE,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QAC/C,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;SAC9D;aAAM;YACL,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;SACjE;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;SAGK;IACL,UAAU,CAAC,OAAgB,EAAE,KAAU;QACrC,IAAI,OAAO,OAAO,KAAK,QAAQ;YAAE,OAAO,KAAK,KAAK,OAAO,CAAA;QACzD,IAAI,OAAO,YAAY,MAAM,EAAE;YAC7B,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;gBAAE,OAAO,KAAK,CAAA;YACvD,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;SAC3B;QACD,IAAI,OAAO,OAAO,KAAK,UAAU;YAAE,OAAO,OAAO,CAAC,KAAK,CAAC,CAAA;QACxD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;SAIK;IACL,eAAe,CACb,KAAY,EACZ,OAAgB,EAChB,QAAkB;QAElB,MAAM,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAA;QAChE,IAAI,YAAY,IAAI,QAAQ,CAAC,aAAa;YACxC,YAAY,CAAC,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAA;QAC5C,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,IAAI,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE;YACrE,OAAO,IAAI,CAAC,8BAA8B,CAAC,YAAY,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;SACxE;QACD,OAAO,IAAI,CAAC,wBAAwB,CAAC,YAAY,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;IACpE,CAAC;IAED;;SAEK;IACL,wBAAwB,CACtB,YAA6B,EAC7B,KAAY,EACZ,OAAgB;;QAEhB,6CAA6C;QAC7C,IAAI,YAAY,IAAI,YAAY,CAAC,WAAW,EAAE;YAC5C,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAC/B,KAAK,EACL,YAAY,CAAC,WAAW,EACxB,OAAO,EACP,YAAY,CAAC,IAAI,CAClB,CAAA;YACD,IAAI,WAAW,EAAE;gBACf,OAAO;oBACL,YAAY;oBACZ,YAAY,kCACP,WAAW,CAAC,KAAK,KACpB,IAAI,EACF,WAAW,CAAC,KAAK,IAAI,YAAY,CAAC,IAAI;4BACpC,CAAC,CAAC,GAAG,YAAY,CAAC,IAAI,IAAI,WAAW,CAAC,KAAK,CAAC,IAAI,EAAE;4BAClD,CAAC,CAAC,YAAY,CAAC,IAAI,GACxB;oBACD,MAAM,EAAE,WAAW,CAAC,MAAM;oBAC1B,YAAY,EAAE,KAAK;iBACpB,CAAA;aACF;SACF;QACD;;;WAGG;QACH,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAC/B,KAAK,EACL,IAAI,CAAC,MAAM,EACX,OAAO,EACP,MAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,IAAI,mCAAI,IAAI,CAC3B,CAAA;QACD,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,IAAI,CAAC,CAAA;QAChD,IAAI,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,KAAK,EAAE;YACtB,OAAO;gBACL,YAAY;gBACZ,YAAY,kCACP,WAAW,CAAC,KAAK,KACpB,IAAI,EAAE,MAAA,MAAA,WAAW,CAAC,KAAK,0CAAE,IAAI,mCAAI,IAAI,GACtC;gBACD,MAAM,EAAE,WAAW,CAAC,MAAM;gBAC1B,YAAY;aACb,CAAA;SACF;QACD,OAAO;YACL,YAAY;YACZ,YAAY,EAAE,IAAI;YAClB,MAAM,EAAE,EAAE;YACV,YAAY;SACb,CAAA;IACH,CAAC;IAED;;SAEK;IACL,8BAA8B,CAC5B,YAA6B,EAC7B,WAAmB;QAEnB,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,4BAA4B,CAAC,WAAW,CAAC,CAAA;QAClE;;WAEG;QACH,MAAM,uBAAuB,GAAG,CAAC,QAAgB,EAAgB,EAAE;YACjE,MAAM,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAA;YAClD,IAAI,CAAC,YAAY,EAAE;gBACjB,OAAO;oBACL,YAAY;oBACZ,YAAY,EAAE,IAAI;oBAClB,MAAM,EAAE,EAAE;oBACV,YAAY,EAAE,IAAI;iBACnB,CAAA;aACF;YACD,OAAO;gBACL,YAAY;gBACZ,YAAY,kCAAO,YAAY,KAAE,IAAI,EAAE,QAAQ,GAAE;gBACjD,MAAM;gBACN,YAAY,EAAE,KAAK;aACpB,CAAA;QACH,CAAC,CAAA;QACD;;WAEG;QACH,8GAA8G;QAC9G,IAAI,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,IAAI,EAAE;YACtB,MAAM,YAAY,GAAG,uBAAuB,CAC1C,GAAG,YAAY,CAAC,IAAI,IAAI,IAAI,EAAE,CAC/B,CAAA;YACD,IAAI,YAAY,CAAC,YAAY;gBAAE,OAAO,YAAY,CAAA;SACnD;QACD,4EAA4E;QAC5E,OAAO,uBAAuB,CAAC,IAAc,CAAC,CAAA;IAChD,CAAC;CACF"}

package/lib/esm/utils.d.ts

@@ -0,0 +1,11 @@
+export declare const isNode: () => boolean;
+export declare const isBrowser: () => boolean;
+export declare function getWebpackEnvVar(webpackEnvVar: string | false, name: string, defaultValue: string): string;
+export declare const isMobile: (mobileBreakpoint?: number) => boolean;
+export declare function isFunction(o: any): boolean;
+export declare function cloneObject(object: any): any;
+export declare const params2queryString: (params: {
+    [key: string]: string;
+}) => string;
+export declare const join: (...segments: string[]) => string;
+export declare const dirname: (path: string) => string;

package/lib/esm/utils.js

@@ -0,0 +1,78 @@
+export const isNode = () => {
+    // @ts-ignore
+    return typeof IS_NODE !== 'undefined'
+        ? // @ts-ignore
+            IS_NODE
+        : typeof process !== 'undefined' &&
+            process.versions !== null &&
+            process.versions.node !== null;
+};
+export const isBrowser = () => {
+    // @ts-ignore
+    return typeof IS_BROWSER !== 'undefined'
+        ? // @ts-ignore
+            IS_BROWSER
+        : typeof window !== 'undefined' &&
+            typeof window.document !== 'undefined' &&
+            !window.process;
+};
+export function getWebpackEnvVar(webpackEnvVar, name, defaultValue) {
+    return (webpackEnvVar ||
+        (typeof process !== 'undefined' && process.env[name]) ||
+        defaultValue);
+}
+export const isMobile = (mobileBreakpoint = 460) => {
+    if (isBrowser()) {
+        const w = Math.max(document.documentElement.clientWidth, window.innerWidth || 0);
+        if (w < mobileBreakpoint) {
+            return true;
+        }
+    }
+    return false;
+};
+export function isFunction(o) {
+    return typeof o === 'function';
+}
+export function cloneObject(object) {
+    if (!object)
+        return {};
+    return Object.assign({}, object);
+}
+export const params2queryString = (params) => Object.entries(params)
+    .map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(v)}`)
+    .join('&');
+// Joins path segments.  Preserves initial "/" and resolves ".." and "."
+// Does not support using ".." to go above/outside the root.
+// This means that join("foo", "../../bar") will not resolve to "../bar"
+export const join = (...segments) => {
+    // Split the inputs into a list of path commands.
+    let parts = [];
+    for (let i = 0, l = segments.length; i < l; i++) {
+        parts = parts.concat(segments[i].split('/'));
+    }
+    // Interpret the path commands to get the new resolved path.
+    const newParts = [];
+    for (let i = 0, l = parts.length; i < l; i++) {
+        const part = parts[i];
+        // Remove leading and trailing slashes
+        // Also remove "." segments
+        if (!part || part === '.')
+            continue;
+        // Interpret ".." to pop the last segment
+        if (part === '..')
+            newParts.pop();
+        // Push new path segments.
+        else
+            newParts.push(part);
+    }
+    // Preserve the initial slash if there was one.
+    // @ts-ignore
+    if (parts[0] === '')
+        newParts.unshift('');
+    // Turn back into a single string path.
+    return newParts.join('/') || (newParts.length ? '/' : '.');
+};
+// A simple function to get the dirname of a path
+// Trailing slashes are ignored. Leading slash is preserved.
+export const dirname = (path) => join(path, '..');
+//# sourceMappingURL=utils.js.map

package/lib/esm/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,MAAM,GAAG,GAAY,EAAE;IAClC,aAAa;IACb,OAAO,OAAO,OAAO,KAAK,WAAW;QACnC,CAAC,CAAC,aAAa;YACb,OAAO;QACT,CAAC,CAAC,OAAO,OAAO,KAAK,WAAW;YAC5B,OAAO,CAAC,QAAQ,KAAK,IAAI;YACzB,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,IAAI,CAAA;AACtC,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,SAAS,GAAG,GAAY,EAAE;IACrC,aAAa;IACb,OAAO,OAAO,UAAU,KAAK,WAAW;QACtC,CAAC,CAAC,aAAa;YACb,UAAU;QACZ,CAAC,CAAC,OAAO,MAAM,KAAK,WAAW;YAC3B,OAAO,MAAM,CAAC,QAAQ,KAAK,WAAW;YACtC,CAAC,MAAM,CAAC,OAAO,CAAA;AACvB,CAAC,CAAA;AAED,MAAM,UAAU,gBAAgB,CAC9B,aAA6B,EAC7B,IAAY,EACZ,YAAoB;IAEpB,OAAO,CACL,aAAa;QACb,CAAC,OAAO,OAAO,KAAK,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACrD,YAAY,CACb,CAAA;AACH,CAAC;AAED,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,gBAAgB,GAAG,GAAG,EAAW,EAAE;IAC1D,IAAI,SAAS,EAAE,EAAE;QACf,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAChB,QAAQ,CAAC,eAAe,CAAC,WAAW,EACpC,MAAM,CAAC,UAAU,IAAI,CAAC,CACvB,CAAA;QACD,IAAI,CAAC,GAAG,gBAAgB,EAAE;YACxB,OAAO,IAAI,CAAA;SACZ;KACF;IACD,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAED,MAAM,UAAU,UAAU,CAAC,CAAM;IAC/B,OAAO,OAAO,CAAC,KAAK,UAAU,CAAA;AAChC,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,MAAW;IACrC,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAA;IACtB,yBAAY,MAAM,EAAE;AACtB,CAAC;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,MAAiC,EAAU,EAAE,CAC9E,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;KACnB,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAM,EAAE,EAAE,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC;KACzE,IAAI,CAAC,GAAG,CAAC,CAAA;AAEd,wEAAwE;AACxE,4DAA4D;AAC5D,wEAAwE;AACxE,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,GAAG,QAAkB,EAAU,EAAE;IACpD,iDAAiD;IACjD,IAAI,KAAK,GAAa,EAAE,CAAA;IACxB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;QAC/C,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;KAC7C;IACD,4DAA4D;IAC5D,MAAM,QAAQ,GAAa,EAAE,CAAA;IAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;QAC5C,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;QACrB,sCAAsC;QACtC,2BAA2B;QAC3B,IAAI,CAAC,IAAI,IAAI,IAAI,KAAK,GAAG;YAAE,SAAQ;QACnC,yCAAyC;QACzC,IAAI,IAAI,KAAK,IAAI;YAAE,QAAQ,CAAC,GAAG,EAAE,CAAA;QACjC,0BAA0B;;YACrB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;KACzB;IACD,+CAA+C;IAC/C,aAAa;IACb,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IACzC,uCAAuC;IACvC,OAAO,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AAC5D,CAAC,CAAA;AAED,iDAAiD;AACjD,4DAA4D;AAC5D,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA"}

package/package.json

@@ -1,16 +1,18 @@
 {
   "name": "@botonic/core",
-  "version": "1.0.0-alpha.0",
+  "version": "1.0.0-dev.2",
   "license": "MIT",
   "description": "Build Chatbots using React",
-  "main": "src/index.js",
-  "types": "./src/types",
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
   "scripts": {
     "test": "../../node_modules/.bin/jest --coverage",
     "prepare": "node ../../preinstall.js",
+    "prepublishOnly": "rm -rf lib && npm run build",
     "lint": "npm run lint_ci -- --fix",
-    "lint_ci": "../../node_modules/.bin/eslint_d --cache --quiet '.*.js' '*.js' 'src/**/*.js*' 'src/**/*.d.ts'",
-    "build": "rm -rf lib && ../../node_modules/.bin/tsc;",
+    "lint_ci": "../../node_modules/.bin/eslint_d --cache --quiet '*.js' 'src/**/*.ts*'",
+    "build": "../../node_modules/.bin/tsc -p tsconfig.json && ../../node_modules/.bin/tsc -p tsconfig.esm.json",
+    "build:watch": "npm run build -- --watch",
     "cloc": "../../scripts/qa/cloc-package.sh ."
   },
   "repository": {
@@ -28,9 +30,9 @@
     "README.md"
   ],
   "dependencies": {
-    "axios": "^0.21.0",
+    "axios": "^0.24.0",
     "decode": "^0.3.0",
-    "fast-xml-parser": "^3.19.0",
+    "fast-xml-parser": "^3.21.1",
     "html-entities": "^2.3.2",
     "pusher-js": "^5.1.1"
   },
@@ -53,5 +55,10 @@
     "conversational-app",
     "conversational-ui",
     "javascript"
-  ]
+  ],
+  "eslintConfig": {
+    "extends": "../.eslintrc.js",
+    "root": true
+  },
+  "sideEffects": false
 }

package/src/constants.ts

@@ -0,0 +1,6 @@
+export const NOT_FOUND_PATH = '404'
+export const EMPTY_ACTION_PATH = ''
+export const PATH_PAYLOAD_IDENTIFIER = '__PATH_PAYLOAD__'
+export const PATH_PAYLOAD_REGEXP = new RegExp(
+  `\\b^${PATH_PAYLOAD_IDENTIFIER}(.*)\\b`
+)

package/src/core-bot.ts

@@ -0,0 +1,181 @@
+import { Inspector } from './debug'
+import { getString } from './i18n'
+import {
+  BotonicEvent,
+  BotRequest,
+  BotResponse,
+  BotState,
+  Locales,
+  Route,
+  Routes,
+  Session,
+} from './models'
+import { BotonicOutputParser } from './output-parser'
+import { loadPlugins, runPlugins } from './plugins'
+import { getComputedRoutes, Router } from './routing'
+
+interface CoreBotConfig {
+  appId?: string
+  defaultDelay?: number
+  defaultRoutes?: Route[]
+  defaultTyping?: number
+  inspector?: Inspector
+  locales: Locales
+  plugins?: any
+  renderer: any
+  routes: Routes
+  theme?: any
+}
+export class CoreBot {
+  appId?: string
+  defaultDelay?: number
+  defaultRoutes: Route[]
+  defaultTyping?: number
+  inspector: Inspector
+  locales: Locales
+  plugins?: Record<string, Plugin>
+  renderer: any
+  rootElement: any
+  router: Router | null
+  routes: Routes
+  theme?: any
+  botonicOutputParser = new BotonicOutputParser()
+
+  constructor({
+    // TODO: Receives dataProvider
+    renderer,
+    routes,
+    locales,
+    theme,
+    plugins,
+    appId,
+    defaultTyping,
+    defaultDelay,
+    defaultRoutes,
+    inspector,
+  }: CoreBotConfig) {
+    this.renderer = renderer
+    this.plugins = loadPlugins(plugins)
+    this.theme = theme || {}
+    this.defaultTyping =
+      typeof defaultTyping !== 'undefined' ? defaultTyping : 0.6
+    this.defaultDelay = typeof defaultDelay !== 'undefined' ? defaultDelay : 0.4
+    this.locales = locales
+    if (appId) {
+      this.appId = appId
+      return
+    }
+    this.rootElement = null
+    this.inspector = inspector || new Inspector()
+    this.routes = routes
+    this.defaultRoutes = defaultRoutes || []
+    this.router =
+      this.routes instanceof Function
+        ? null
+        : new Router(
+            [...this.routes, ...this.defaultRoutes],
+            this.inspector.routeInspector
+          )
+  }
+
+  getString(id: string, botState: BotState): string {
+    if (!botState.locale) {
+      console.error('Locale is not defined')
+      return ''
+    }
+    return getString(this.locales, botState.locale, id)
+  }
+
+  setLocale(locale: string, botState: BotState): void {
+    botState.locale = locale
+  }
+
+  async input({
+    input,
+    session,
+    botState,
+    dataProvider,
+  }: BotRequest): Promise<BotResponse> {
+    if (!botState?.locale) botState.locale = 'en'
+    if (this.plugins) {
+      await runPlugins(
+        this.plugins,
+        'pre',
+        input,
+        session,
+        botState,
+        undefined,
+        undefined,
+        dataProvider
+      )
+    }
+
+    if (this.routes instanceof Function) {
+      this.router = new Router(
+        [
+          ...(await getComputedRoutes(this.routes, {
+            input,
+            session,
+            botState,
+          })),
+          ...this.defaultRoutes,
+        ],
+        this.inspector.routeInspector
+      )
+    }
+
+    const output = (this.router as Router).processInput(
+      input,
+      session,
+      botState
+    )
+
+    const request = {
+      getString: stringId => this.getString(stringId, botState),
+      setLocale: locale => this.setLocale(locale, botState),
+      session: session || {},
+      params: output.params || {},
+      input: input,
+      plugins: this.plugins,
+      defaultTyping: this.defaultTyping,
+      defaultDelay: this.defaultDelay,
+      botState,
+      dataProvider,
+    }
+
+    const response = await this.renderer({
+      request,
+      actions: [output.fallbackAction, output.action, output.emptyAction],
+    })
+
+    const messageEvents: Partial<BotonicEvent>[] = this.botonicOutputParser.xmlToMessageEvents(
+      response
+    )
+
+    botState.lastRoutePath = output.botState.lastRoutePath // not needed if updated below
+
+    if (this.plugins) {
+      await runPlugins(
+        this.plugins,
+        'post',
+        input,
+        session, // passing output.session instead
+        botState, // passing output.botState instead
+        response,
+        messageEvents,
+        dataProvider
+      )
+    }
+
+    botState.isFirstInteraction = false
+
+    return {
+      input, // Delete
+      response, // xml/rendered react for actions (not needed)
+      messageEvents, // xml to Botonic Events
+      session, // to be output.session
+      botState, // to be output.botState
+      dataProvider, // no need to return it
+    }
+  }
+}