@botonic/core 0.56.0-alpha.0 → 0.57.0-rslib-esm.1

package/lib/routing/router.js

@@ -0,0 +1,333 @@
+import { NOT_FOUND_PATH } from "../constants.js";
+import { RouteInspector } from "../debug/inspector.js";
+import { cloneObject } from "../utils/index.js";
+import { getEmptyAction, getNotFoundAction, getPathParamsFromPathPayload, isPathPayload } from "./router-utils.js";
+
+
+
+
+
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else obj[key] = value;
+    return obj;
+}
+
+
+
+
+class Router {
+    /**
+   * 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, lastRoutePath = null) {
+        session.__retries = session?.__retries ?? 0;
+        // 1. Getting the current routing state.
+        const { currentRoute, matchedRoute, params, isFlowBroken } = this.getRoutingState(input, session, lastRoutePath);
+        const currentRoutePath = currentRoute?.path ?? null;
+        const matchedRoutePath = matchedRoute?.path ?? 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?.redirect) {
+            session.__retries = 0;
+            const redirectionRoute = this.getRouteByPath(matchedRoute.redirect);
+            if (redirectionRoute) {
+                return {
+                    action: redirectionRoute.action,
+                    emptyAction: getEmptyAction(redirectionRoute.childRoutes),
+                    fallbackAction: null,
+                    lastRoutePath: matchedRoute.redirect,
+                    params
+                };
+            }
+            return {
+                action: null,
+                emptyAction: null,
+                fallbackAction: getNotFoundAction(input, this.routes),
+                lastRoutePath: null,
+                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?.ignoreRetry) {
+            session.__retries = 0;
+            return {
+                action: matchedRoute.action,
+                emptyAction: getEmptyAction(matchedRoute.childRoutes),
+                fallbackAction: null,
+                lastRoutePath: matchedRoutePath,
+                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 && session.__retries < currentRoute.retry) {
+            session.__retries = session.__retries !== 0 ? session.__retries + 1 : 1;
+            if (matchedRoute && matchedRoutePath !== NOT_FOUND_PATH) {
+                return {
+                    action: currentRoute.action,
+                    emptyAction: getEmptyAction(matchedRoute.childRoutes),
+                    fallbackAction: matchedRoute.action,
+                    lastRoutePath: currentRoutePath,
+                    params
+                };
+            }
+            return {
+                action: currentRoute.action ?? null,
+                emptyAction: getEmptyAction(currentRoute.childRoutes),
+                fallbackAction: getNotFoundAction(input, this.routes),
+                lastRoutePath: currentRoutePath,
+                params
+            };
+        }
+        /**
+     * Default Scenario:
+     * We have matched a route or not, but we don't need to execute retries logic, so retries stay to 0.
+     */ session.__retries = 0;
+        /**
+     * Matching Route Scenario:
+     * We have matched a route, so we return the new bot state.
+     */ if (matchedRoute && matchedRoutePath !== NOT_FOUND_PATH) {
+            return {
+                action: matchedRoute.action ?? null,
+                emptyAction: getEmptyAction(matchedRoute.childRoutes),
+                fallbackAction: null,
+                lastRoutePath: matchedRoutePath,
+                params
+            };
+        }
+        /**
+     * 404 Scenario (No Route Found):
+     * We have not matched any route, so we return the new bot state.
+     */ return {
+            action: null,
+            emptyAction: null,
+            fallbackAction: getNotFoundAction(input, this.routes),
+            params,
+            lastRoutePath: currentRoutePath
+        };
+    }
+    /**
+   * 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 = {
+                            ...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?.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 === 'text') {
+            value = input.data;
+        } 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, lastRoutePath) {
+        const currentRoute = this.getRouteByPath(lastRoutePath);
+        if (currentRoute && lastRoutePath) {
+            currentRoute.path = 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) {
+        // get route depending of current ChildRoutes
+        if (currentRoute?.childRoutes) {
+            const routeParams = this.getRoute(input, currentRoute.childRoutes, session, currentRoute.path);
+            if (routeParams) {
+                return {
+                    currentRoute,
+                    matchedRoute: {
+                        ...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, currentRoute?.path ?? null);
+        const isFlowBroken = Boolean(currentRoute?.path);
+        if (routeParams?.route) {
+            return {
+                currentRoute,
+                matchedRoute: {
+                    ...routeParams.route,
+                    path: routeParams.route?.path ?? 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: {
+                    ...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?.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);
+    }
+    constructor(routes, routeInspector = undefined){
+        _define_property(this, "routes", void 0);
+        _define_property(this, "routeInspector", void 0);
+        this.routes = routes;
+        this.routeInspector = routeInspector || new RouteInspector();
+    }
+}
+
+export { Router };
+
+//# sourceMappingURL=router.js.map

package/lib/routing/router.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"routing/router.js","sources":["../../src/routing/router.ts"],"sourcesContent":["import { NOT_FOUND_PATH } from '../constants'\nimport { RouteInspector } from '../debug/inspector'\nimport type {\n  Input,\n  MatchedValue,\n  Matcher,\n  MatchingProp,\n  Nullable,\n  ProcessInputResult,\n  Route,\n  RouteParams,\n  RoutePath,\n  RoutingState,\n  Session,\n} from '../models'\nimport { cloneObject } from '../utils'\nimport {\n  getEmptyAction,\n  getNotFoundAction,\n  getPathParamsFromPathPayload,\n  isPathPayload,\n} from './router-utils'\n\nexport class Router {\n  routes: Route[]\n  routeInspector: RouteInspector\n\n  constructor(\n    routes: Route[],\n    routeInspector: RouteInspector | undefined = undefined\n  ) {\n    this.routes = routes\n    this.routeInspector = routeInspector || new RouteInspector()\n  }\n\n  /**\n   * Processes an input and return a representation of the new bot state.\n   * The algorithm is splitted in two main parts:\n   * 1. Getting the current routing state.\n   * 2. Given a routing state, resolve the different possible scenarios and return the new bot state.\n   * The new bot state can return three type of actions:\n   * - action: an action directly resolved from a matching route\n   * - emptyAction: optional action that can exists or not only within childRoutes\n   * - fallbackAction: any other action that acts as a fallback (404, )\n   */\n\n  // eslint-disable-next-line complexity\n  processInput(\n    input: Input,\n    session: Session,\n    lastRoutePath: RoutePath = null\n  ): ProcessInputResult {\n    session.__retries = session?.__retries ?? 0\n\n    // 1. Getting the current routing state.\n    const { currentRoute, matchedRoute, params, isFlowBroken } =\n      this.getRoutingState(input, session, lastRoutePath)\n\n    const currentRoutePath = currentRoute?.path ?? null\n    const matchedRoutePath = matchedRoute?.path ?? null\n\n    // 2. Given a routing state, resolve the different possible scenarios and return the new bot state.\n\n    /**\n     * Redirect Scenario:\n     * We have matched a redirect route with a given redirection path, so we try to obtain the redirectionRoute with getRouteByPath.\n     * 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.\n     * It has preference over ignoring retries.\n     */\n    if (matchedRoute?.redirect) {\n      session.__retries = 0\n      const redirectionRoute = this.getRouteByPath(matchedRoute.redirect)\n      if (redirectionRoute) {\n        return {\n          action: redirectionRoute.action,\n          emptyAction: getEmptyAction(redirectionRoute.childRoutes),\n          fallbackAction: null,\n          lastRoutePath: matchedRoute.redirect,\n          params,\n        }\n      }\n      return {\n        action: null,\n        emptyAction: null,\n        fallbackAction: getNotFoundAction(input, this.routes),\n        lastRoutePath: null,\n        params,\n      }\n    }\n\n    /**\n     * Ignore Retry Scenario:\n     * 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.\n     */\n    if (matchedRoute?.ignoreRetry) {\n      session.__retries = 0\n      return {\n        action: matchedRoute.action,\n        emptyAction: getEmptyAction(matchedRoute.childRoutes),\n        fallbackAction: null,\n        lastRoutePath: matchedRoutePath,\n        params,\n      }\n    }\n\n    /**\n     * Retry Scenario:\n     * We were in a route which had retries enabled, so we check if the number of retries is exceeded.\n     * 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.\n     */\n    if (\n      isFlowBroken &&\n      currentRoute &&\n      currentRoute.retry &&\n      session.__retries < currentRoute.retry\n    ) {\n      session.__retries = session.__retries !== 0 ? session.__retries + 1 : 1\n      if (matchedRoute && matchedRoutePath !== NOT_FOUND_PATH) {\n        return {\n          action: currentRoute.action,\n          emptyAction: getEmptyAction(matchedRoute.childRoutes),\n          fallbackAction: matchedRoute.action,\n          lastRoutePath: currentRoutePath,\n          params,\n        }\n      }\n      return {\n        action: currentRoute.action ?? null,\n        emptyAction: getEmptyAction(currentRoute.childRoutes),\n        fallbackAction: getNotFoundAction(input, this.routes),\n        lastRoutePath: currentRoutePath,\n        params,\n      }\n    }\n\n    /**\n     * Default Scenario:\n     * We have matched a route or not, but we don't need to execute retries logic, so retries stay to 0.\n     */\n    session.__retries = 0\n\n    /**\n     * Matching Route Scenario:\n     * We have matched a route, so we return the new bot state.\n     */\n    if (matchedRoute && matchedRoutePath !== NOT_FOUND_PATH) {\n      return {\n        action: matchedRoute.action ?? null,\n        emptyAction: getEmptyAction(matchedRoute.childRoutes),\n        fallbackAction: null,\n        lastRoutePath: matchedRoutePath,\n        params,\n      }\n    }\n\n    /**\n     * 404 Scenario (No Route Found):\n     * We have not matched any route, so we return the new bot state.\n     */\n    return {\n      action: null,\n      emptyAction: null,\n      fallbackAction: getNotFoundAction(input, this.routes),\n      params,\n      lastRoutePath: currentRoutePath,\n    }\n  }\n\n  /**\n   * 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.\n   * IMPORTANT: It returns a cloned route instead of the route itself to avoid modifying original routes and introduce side effects\n   * */\n  getRoute(\n    input: Input | Partial<Input>,\n    routes: Route[],\n    session: Session,\n    lastRoutePath: RoutePath\n  ): RouteParams | null {\n    let params = {}\n    const route = routes.find(r =>\n      Object.entries(r)\n        .filter(\n          ([key, _]) =>\n            key !== 'action' && key !== 'childRoutes' && key !== 'path'\n        )\n        .some(([key, value]) => {\n          const match = this.matchRoute(\n            r,\n            key as MatchingProp,\n            value as Matcher,\n            input as Input,\n            session,\n            lastRoutePath\n          )\n          try {\n            if (match !== null && typeof match !== 'boolean' && match.groups) {\n              // Strip '[Object: null prototype]' from groups result: https://stackoverflow.com/a/62945609/6237608\n              params = { ...match.groups }\n            }\n          } catch (_e) {}\n          return Boolean(match)\n        })\n    )\n    if (route) {\n      return { route: cloneObject(route), params }\n    }\n    return null\n  }\n\n  /**\n   * Find the route that matches the given path. Path can include concatenations, e.g: 'Flow1/Subflow1.1'.\n   * IMPORTANT: It returns a cloned route instead of the route itself to avoid modifying original routes and introduce side effects\n   * */\n  getRouteByPath(\n    path: RoutePath,\n    routeList: Route[] = this.routes\n  ): Nullable<Route> {\n    if (!path) {\n      return null\n    }\n    const [currentPath, ...childPath] = path.split('/')\n    for (const route of routeList) {\n      // iterate over all routeList\n      if (route.path === currentPath) {\n        if (route.childRoutes?.length && childPath.length > 0) {\n          // evaluate childroute over next actions\n          const computedRoute = this.getRouteByPath(\n            childPath.join('/'),\n            route.childRoutes\n          )\n          // IMPORTANT: Returning a new object to avoid modifying dev routes and introduce side effects\n          if (computedRoute) {\n            return cloneObject(computedRoute)\n          }\n        } else if (childPath.length === 0) {\n          return cloneObject(route) // last action and found route\n        }\n      }\n    }\n    return null\n  }\n\n  /**\n   * Returns the matched value for a specific route.\n   * Matching Props: ('text' | 'payload' | 'intent' | 'type' | 'input' | 'session' | 'request' ...)\n   * Matchers: (string: exact match | regex: regular expression match | function: return true)\n   * input: user input object, e.g.: {type: 'text', data: 'Hi'}\n   * */\n  matchRoute(\n    route: Route,\n    prop: MatchingProp,\n    matcher: Matcher,\n    input: Input,\n    session: Session,\n    lastRoutePath: RoutePath\n  ): MatchedValue {\n    let value: any = null\n    if (Object.keys(input).indexOf(prop) > -1) {\n      value = input[prop]\n    } else if (prop === 'text') {\n      value = input.data\n    } else if (prop === 'input') {\n      value = input\n    } else if (prop === 'session') {\n      value = session\n    } else if (prop === 'request') {\n      value = { input, session, lastRoutePath }\n    }\n    const matched = this.matchValue(matcher, value)\n    if (matched) {\n      this.routeInspector.routeMatched(route, prop, matcher, value)\n    } else {\n      this.routeInspector.routeNotMatched(route, prop, matcher, value)\n    }\n    return matched\n  }\n\n  /**\n   * Runs the matcher against the given value.\n   * If there is a match, it will return a truthy value (true, RegExp result), o.w., it will return a falsy value.\n   * */\n  matchValue(matcher: Matcher, value: any): MatchedValue {\n    if (typeof matcher === 'string') {\n      return value === matcher\n    }\n    if (matcher instanceof RegExp) {\n      if (value === undefined || value === null) {\n        return false\n      }\n      return matcher.exec(value)\n    }\n    if (typeof matcher === 'function') {\n      return matcher(value)\n    }\n    return false\n  }\n\n  /**\n   * It resolves the current state of navigation. Two scenarios:\n   * 1. Given a path payload input (__PATH_PAYLOAD__somePath?someParam=someValue), we can resolve the routing state directly from it (using getRouteByPath).\n   * 2. Given any other type of input, we resolve the routing state with normal resolution (using getRoute).\n   * */\n  getRoutingState(\n    input: Input,\n    session: Session,\n    lastRoutePath: RoutePath\n  ): RoutingState {\n    const currentRoute = this.getRouteByPath(lastRoutePath)\n    if (currentRoute && lastRoutePath) {\n      currentRoute.path = lastRoutePath\n    }\n    if (typeof input.payload === 'string' && isPathPayload(input.payload)) {\n      return this.getRoutingStateFromPathPayload(currentRoute, input.payload)\n    }\n    return this.getRoutingStateFromInput(currentRoute, input, session)\n  }\n\n  /**\n   * 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.\n   * */\n  getRoutingStateFromInput(\n    currentRoute: Nullable<Route>,\n    input: Input,\n    session: Session\n  ): RoutingState {\n    // get route depending of current ChildRoutes\n    if (currentRoute?.childRoutes) {\n      const routeParams = this.getRoute(\n        input,\n        currentRoute.childRoutes,\n        session,\n        currentRoute.path\n      )\n      if (routeParams) {\n        return {\n          currentRoute,\n          matchedRoute: {\n            ...routeParams.route,\n            path:\n              routeParams.route && currentRoute.path\n                ? `${currentRoute.path}/${routeParams.route.path}`\n                : currentRoute.path,\n          },\n          params: routeParams.params,\n          isFlowBroken: false,\n        }\n      }\n    }\n    /**\n     * we couldn't find a route in the state of the currentRoute childRoutes,\n     * so let's find in the general routes\n     */\n    const routeParams = this.getRoute(\n      input,\n      this.routes,\n      session,\n      currentRoute?.path ?? null\n    )\n    const isFlowBroken = Boolean(currentRoute?.path)\n    if (routeParams?.route) {\n      return {\n        currentRoute,\n        matchedRoute: {\n          ...routeParams.route,\n          path: routeParams.route?.path ?? null,\n        },\n        params: routeParams.params,\n        isFlowBroken,\n      }\n    }\n    return {\n      currentRoute,\n      matchedRoute: null,\n      params: {},\n      isFlowBroken,\n    }\n  }\n\n  /**\n   * 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.\n   * */\n  getRoutingStateFromPathPayload(\n    currentRoute: Nullable<Route>,\n    pathPayload: string\n  ): RoutingState {\n    const { path, params } = getPathParamsFromPathPayload(pathPayload)\n    /**\n     * shorthand function to update the matching information given a path\n     */\n    const getRoutingStateFromPath = (seekPath: string): RoutingState => {\n      const matchedRoute = this.getRouteByPath(seekPath)\n      if (!matchedRoute) {\n        return {\n          currentRoute,\n          matchedRoute: null,\n          params: {},\n          isFlowBroken: true,\n        }\n      }\n      return {\n        currentRoute,\n        matchedRoute: { ...matchedRoute, path: seekPath },\n        params,\n        isFlowBroken: false,\n      }\n    }\n    /**\n     * Given a valid path: 'Flow1/Subflow1' we are in one of the two scenarios below.\n     */\n    //  1. Received __PATH_PAYLOAD__Subflow2, so we need to first try to concatenate it with Flow1 (lastRoutePath)\n    if (currentRoute?.path) {\n      const routingState = getRoutingStateFromPath(\n        `${currentRoute.path}/${path}`\n      )\n      if (routingState.matchedRoute) {\n        return routingState\n      }\n    }\n    // 2. Received __PATH_PAYLOAD__Flow1/Subflow1, so we can resolve it directly\n    return getRoutingStateFromPath(path as string)\n  }\n}\n"],"names":["NOT_FOUND_PATH","RouteInspector","cloneObject","getEmptyAction","getNotFoundAction","getPathParamsFromPathPayload","isPathPayload","Router","input","session","lastRoutePath","currentRoute","matchedRoute","params","isFlowBroken","currentRoutePath","matchedRoutePath","redirectionRoute","routes","route","r","Object","key","_","value","match","_e","Boolean","path","routeList","currentPath","childPath","computedRoute","prop","matcher","matched","RegExp","undefined","routeParams","pathPayload","getRoutingStateFromPath","seekPath","routingState","routeInspector"],"mappings":";;;;;;;;;;;;;;;;;;;;AAA6C;AACM;AAcb;AAMf;AAEhB,MAAMO,MAAMA;IAYjB;;;;;;;;;GASC,GAED,sCAAsC;IACtC,aACEC,KAAY,EACZC,OAAgB,EAChBC,gBAA2B,IAAI,EACX;QACpBD,QAAQ,SAAS,GAAGA,SAAS,aAAa;QAE1C,wCAAwC;QACxC,MAAM,EAAEE,YAAY,EAAEC,YAAY,EAAEC,MAAM,EAAEC,YAAY,EAAE,GACxD,IAAI,CAAC,eAAe,CAACN,OAAOC,SAASC;QAEvC,MAAMK,mBAAmBJ,cAAc,QAAQ;QAC/C,MAAMK,mBAAmBJ,cAAc,QAAQ;QAE/C,mGAAmG;QAEnG;;;;;KAKC,GACD,IAAIA,cAAc,UAAU;YAC1BH,QAAQ,SAAS,GAAG;YACpB,MAAMQ,mBAAmB,IAAI,CAAC,cAAc,CAACL,aAAa,QAAQ;YAClE,IAAIK,kBAAkB;gBACpB,OAAO;oBACL,QAAQA,iBAAiB,MAAM;oBAC/B,aAAad,cAAcA,CAACc,iBAAiB,WAAW;oBACxD,gBAAgB;oBAChB,eAAeL,aAAa,QAAQ;oBACpCC;gBACF;YACF;YACA,OAAO;gBACL,QAAQ;gBACR,aAAa;gBACb,gBAAgBT,iBAAiBA,CAACI,OAAO,IAAI,CAAC,MAAM;gBACpD,eAAe;gBACfK;YACF;QACF;QAEA;;;KAGC,GACD,IAAID,cAAc,aAAa;YAC7BH,QAAQ,SAAS,GAAG;YACpB,OAAO;gBACL,QAAQG,aAAa,MAAM;gBAC3B,aAAaT,cAAcA,CAACS,aAAa,WAAW;gBACpD,gBAAgB;gBAChB,eAAeI;gBACfH;YACF;QACF;QAEA;;;;KAIC,GACD,IACEC,gBACAH,gBACAA,aAAa,KAAK,IAClBF,QAAQ,SAAS,GAAGE,aAAa,KAAK,EACtC;YACAF,QAAQ,SAAS,GAAGA,QAAQ,SAAS,KAAK,IAAIA,QAAQ,SAAS,GAAG,IAAI;YACtE,IAAIG,gBAAgBI,qBAAqBhB,cAAcA,EAAE;gBACvD,OAAO;oBACL,QAAQW,aAAa,MAAM;oBAC3B,aAAaR,cAAcA,CAACS,aAAa,WAAW;oBACpD,gBAAgBA,aAAa,MAAM;oBACnC,eAAeG;oBACfF;gBACF;YACF;YACA,OAAO;gBACL,QAAQF,aAAa,MAAM,IAAI;gBAC/B,aAAaR,cAAcA,CAACQ,aAAa,WAAW;gBACpD,gBAAgBP,iBAAiBA,CAACI,OAAO,IAAI,CAAC,MAAM;gBACpD,eAAeO;gBACfF;YACF;QACF;QAEA;;;KAGC,GACDJ,QAAQ,SAAS,GAAG;QAEpB;;;KAGC,GACD,IAAIG,gBAAgBI,qBAAqBhB,cAAcA,EAAE;YACvD,OAAO;gBACL,QAAQY,aAAa,MAAM,IAAI;gBAC/B,aAAaT,cAAcA,CAACS,aAAa,WAAW;gBACpD,gBAAgB;gBAChB,eAAeI;gBACfH;YACF;QACF;QAEA;;;KAGC,GACD,OAAO;YACL,QAAQ;YACR,aAAa;YACb,gBAAgBT,iBAAiBA,CAACI,OAAO,IAAI,CAAC,MAAM;YACpDK;YACA,eAAeE;QACjB;IACF;IAEA;;;KAGG,GACH,SACEP,KAA6B,EAC7BU,MAAe,EACfT,OAAgB,EAChBC,aAAwB,EACJ;QACpB,IAAIG,SAAS,CAAC;QACd,MAAMM,QAAQD,OAAO,IAAI,CAACE,CAAAA,IACxBC,OAAO,OAAO,CAACD,GACZ,MAAM,CACL,CAAC,CAACE,KAAKC,EAAE,GACPD,QAAQ,YAAYA,QAAQ,iBAAiBA,QAAQ,QAExD,IAAI,CAAC,CAAC,CAACA,KAAKE,MAAM;gBACjB,MAAMC,QAAQ,IAAI,CAAC,UAAU,CAC3BL,GACAE,KACAE,OACAhB,OACAC,SACAC;gBAEF,IAAI;oBACF,IAAIe,UAAU,QAAQ,OAAOA,UAAU,aAAaA,MAAM,MAAM,EAAE;wBAChE,oGAAoG;wBACpGZ,SAAS;4BAAE,GAAGY,MAAM,MAAM;wBAAC;oBAC7B;gBACF,EAAE,OAAOC,IAAI,CAAC;gBACd,OAAOC,QAAQF;YACjB;QAEJ,IAAIN,OAAO;YACT,OAAO;gBAAE,OAAOjB,WAAWA,CAACiB;gBAAQN;YAAO;QAC7C;QACA,OAAO;IACT;IAEA;;;KAGG,GACH,eACEe,IAAe,EACfC,YAAqB,IAAI,CAAC,MAAM,EACf;QACjB,IAAI,CAACD,MAAM;YACT,OAAO;QACT;QACA,MAAM,CAACE,aAAa,GAAGC,UAAU,GAAGH,KAAK,KAAK,CAAC;QAC/C,KAAK,MAAMT,SAASU,UAAW;YAC7B,6BAA6B;YAC7B,IAAIV,MAAM,IAAI,KAAKW,aAAa;gBAC9B,IAAIX,MAAM,WAAW,EAAE,UAAUY,UAAU,MAAM,GAAG,GAAG;oBACrD,wCAAwC;oBACxC,MAAMC,gBAAgB,IAAI,CAAC,cAAc,CACvCD,UAAU,IAAI,CAAC,MACfZ,MAAM,WAAW;oBAEnB,6FAA6F;oBAC7F,IAAIa,eAAe;wBACjB,OAAO9B,WAAWA,CAAC8B;oBACrB;gBACF,OAAO,IAAID,UAAU,MAAM,KAAK,GAAG;oBACjC,OAAO7B,WAAWA,CAACiB,OAAO,8BAA8B;;gBAC1D;YACF;QACF;QACA,OAAO;IACT;IAEA;;;;;KAKG,GACH,WACEA,KAAY,EACZc,IAAkB,EAClBC,OAAgB,EAChB1B,KAAY,EACZC,OAAgB,EAChBC,aAAwB,EACV;QACd,IAAIc,QAAa;QACjB,IAAIH,OAAO,IAAI,CAACb,OAAO,OAAO,CAACyB,QAAQ,CAAC,GAAG;YACzCT,QAAQhB,KAAK,CAACyB,KAAK;QACrB,OAAO,IAAIA,SAAS,QAAQ;YAC1BT,QAAQhB,MAAM,IAAI;QACpB,OAAO,IAAIyB,SAAS,SAAS;YAC3BT,QAAQhB;QACV,OAAO,IAAIyB,SAAS,WAAW;YAC7BT,QAAQf;QACV,OAAO,IAAIwB,SAAS,WAAW;YAC7BT,QAAQ;gBAAEhB;gBAAOC;gBAASC;YAAc;QAC1C;QACA,MAAMyB,UAAU,IAAI,CAAC,UAAU,CAACD,SAASV;QACzC,IAAIW,SAAS;YACX,IAAI,CAAC,cAAc,CAAC,YAAY,CAAChB,OAAOc,MAAMC,SAASV;QACzD,OAAO;YACL,IAAI,CAAC,cAAc,CAAC,eAAe,CAACL,OAAOc,MAAMC,SAASV;QAC5D;QACA,OAAOW;IACT;IAEA;;;KAGG,GACH,WAAWD,OAAgB,EAAEV,KAAU,EAAgB;QACrD,IAAI,OAAOU,YAAY,UAAU;YAC/B,OAAOV,UAAUU;QACnB;QACA,IAAIA,mBAAmBE,QAAQ;YAC7B,IAAIZ,UAAUa,aAAab,UAAU,MAAM;gBACzC,OAAO;YACT;YACA,OAAOU,QAAQ,IAAI,CAACV;QACtB;QACA,IAAI,OAAOU,YAAY,YAAY;YACjC,OAAOA,QAAQV;QACjB;QACA,OAAO;IACT;IAEA;;;;KAIG,GACH,gBACEhB,KAAY,EACZC,OAAgB,EAChBC,aAAwB,EACV;QACd,MAAMC,eAAe,IAAI,CAAC,cAAc,CAACD;QACzC,IAAIC,gBAAgBD,eAAe;YACjCC,aAAa,IAAI,GAAGD;QACtB;QACA,IAAI,OAAOF,MAAM,OAAO,KAAK,YAAYF,aAAaA,CAACE,MAAM,OAAO,GAAG;YACrE,OAAO,IAAI,CAAC,8BAA8B,CAACG,cAAcH,MAAM,OAAO;QACxE;QACA,OAAO,IAAI,CAAC,wBAAwB,CAACG,cAAcH,OAAOC;IAC5D;IAEA;;KAEG,GACH,yBACEE,YAA6B,EAC7BH,KAAY,EACZC,OAAgB,EACF;QACd,6CAA6C;QAC7C,IAAIE,cAAc,aAAa;YAC7B,MAAM2B,cAAc,IAAI,CAAC,QAAQ,CAC/B9B,OACAG,aAAa,WAAW,EACxBF,SACAE,aAAa,IAAI;YAEnB,IAAI2B,aAAa;gBACf,OAAO;oBACL3B;oBACA,cAAc;wBACZ,GAAG2B,YAAY,KAAK;wBACpB,MACEA,YAAY,KAAK,IAAI3B,aAAa,IAAI,GAClC,GAAGA,aAAa,IAAI,CAAC,CAAC,EAAE2B,YAAY,KAAK,CAAC,IAAI,EAAE,GAChD3B,aAAa,IAAI;oBACzB;oBACA,QAAQ2B,YAAY,MAAM;oBAC1B,cAAc;gBAChB;YACF;QACF;QACA;;;KAGC,GACD,MAAMA,cAAc,IAAI,CAAC,QAAQ,CAC/B9B,OACA,IAAI,CAAC,MAAM,EACXC,SACAE,cAAc,QAAQ;QAExB,MAAMG,eAAea,QAAQhB,cAAc;QAC3C,IAAI2B,aAAa,OAAO;YACtB,OAAO;gBACL3B;gBACA,cAAc;oBACZ,GAAG2B,YAAY,KAAK;oBACpB,MAAMA,YAAY,KAAK,EAAE,QAAQ;gBACnC;gBACA,QAAQA,YAAY,MAAM;gBAC1BxB;YACF;QACF;QACA,OAAO;YACLH;YACA,cAAc;YACd,QAAQ,CAAC;YACTG;QACF;IACF;IAEA;;KAEG,GACH,+BACEH,YAA6B,EAC7B4B,WAAmB,EACL;QACd,MAAM,EAAEX,IAAI,EAAEf,MAAM,EAAE,GAAGR,4BAA4BA,CAACkC;QACtD;;KAEC,GACD,MAAMC,0BAA0B,CAACC;YAC/B,MAAM7B,eAAe,IAAI,CAAC,cAAc,CAAC6B;YACzC,IAAI,CAAC7B,cAAc;gBACjB,OAAO;oBACLD;oBACA,cAAc;oBACd,QAAQ,CAAC;oBACT,cAAc;gBAChB;YACF;YACA,OAAO;gBACLA;gBACA,cAAc;oBAAE,GAAGC,YAAY;oBAAE,MAAM6B;gBAAS;gBAChD5B;gBACA,cAAc;YAChB;QACF;QACA;;KAEC,GACD,8GAA8G;QAC9G,IAAIF,cAAc,MAAM;YACtB,MAAM+B,eAAeF,wBACnB,GAAG7B,aAAa,IAAI,CAAC,CAAC,EAAEiB,MAAM;YAEhC,IAAIc,aAAa,YAAY,EAAE;gBAC7B,OAAOA;YACT;QACF;QACA,4EAA4E;QAC5E,OAAOF,wBAAwBZ;IACjC;IAzYA,YACEV,MAAe,EACfyB,iBAA6CN,SAAS,CACtD;QANF;QACA;QAME,IAAI,CAAC,MAAM,GAAGnB;QACd,IAAI,CAAC,cAAc,GAAGyB,kBAAkB,IAAI1C,cAAcA;IAC5D;AAoYF"}

package/lib/{esm/testing → testing}/index.d.ts

@@ -1,4 +1,4 @@
-import { type BotContext, type BotRequest, type BotSecrets, type BotSettings, type ContactInfo, type Input, type ProviderType, type ResolvedPlugins, type Session, type SessionUser } from '../models';
+import { type BotContext, type BotRequest, type BotSecrets, type BotSettings, type ContactInfo, type Input, type ProviderType, type ResolvedPlugins, type Session, type SessionUser } from '../models/index.js';
 export declare const TEST_DEFAULTS: {
     HUBTYPE_API_URL: string;
     STATIC_URL: string;

package/lib/testing/index.js

@@ -0,0 +1,162 @@
+import { INPUT, PROVIDER } from "../models/index.js";
+
+
+
+// ---------------------------------------------------------------------------
+// Default values
+// ---------------------------------------------------------------------------
+const TEST_DEFAULTS = {
+    HUBTYPE_API_URL: 'https://api.hubtype.com',
+    STATIC_URL: 'https://static.hubtype.com',
+    LITELLM_API_URL: 'https://api.litellm.com',
+    AZURE_OPENAI_API_BASE: 'https://api.openai.com',
+    AZURE_OPENAI_API_VERSION: '2026-02-01',
+    LANGUAGE_DETECTION_ENABLED: true,
+    HUBTYPE_ACCESS_TOKEN: 'testAccessToken',
+    LITELLM_API_KEY: 'testLiteLLMAPIKey',
+    AZURE_OPENAI_API_KEY: 'testAzureOpenAIAPIKey',
+    ACCESS_TOKEN: 'fake_access_token',
+    HUBTYPE_API_HOST: 'https://api.hubtype.com',
+    FLOW_THREAD_ID: 'testFlowThreadId',
+    BOT_ID: 'testBotId',
+    USER_ID: 'testUserId',
+    ORG_ID: 'testOrgId',
+    ORG_NAME: 'testOrg',
+    PROVIDER: PROVIDER.WEBCHAT,
+    LOCALE: 'en',
+    COUNTRY: 'US',
+    BOT_INTERACTION_ID: 'testInteractionId',
+    MESSAGE_ID: 'testMessageId',
+    LAST_ROUTE_PATH: ''
+};
+// ---------------------------------------------------------------------------
+// Leaf factories
+// ---------------------------------------------------------------------------
+function createTestSettings(overrides) {
+    return {
+        HUBTYPE_API_URL: TEST_DEFAULTS.HUBTYPE_API_URL,
+        STATIC_URL: TEST_DEFAULTS.STATIC_URL,
+        LITELLM_API_URL: TEST_DEFAULTS.LITELLM_API_URL,
+        AZURE_OPENAI_API_BASE: TEST_DEFAULTS.AZURE_OPENAI_API_BASE,
+        AZURE_OPENAI_API_VERSION: TEST_DEFAULTS.AZURE_OPENAI_API_VERSION,
+        LANGUAGE_DETECTION_ENABLED: TEST_DEFAULTS.LANGUAGE_DETECTION_ENABLED,
+        CUSTOM_SHORT_URL_HOST: null,
+        custom: {},
+        ...overrides
+    };
+}
+function createTestSecrets(overrides) {
+    return {
+        HUBTYPE_ACCESS_TOKEN: TEST_DEFAULTS.HUBTYPE_ACCESS_TOKEN,
+        LITELLM_API_KEY: TEST_DEFAULTS.LITELLM_API_KEY,
+        AZURE_OPENAI_API_KEY: TEST_DEFAULTS.AZURE_OPENAI_API_KEY,
+        custom: {},
+        ...overrides
+    };
+}
+function createTestSessionUser(options) {
+    const locale = options?.locale ?? TEST_DEFAULTS.LOCALE;
+    const country = options?.country ?? TEST_DEFAULTS.COUNTRY;
+    return {
+        id: options?.id ?? TEST_DEFAULTS.USER_ID,
+        provider: options?.provider ?? TEST_DEFAULTS.PROVIDER,
+        locale,
+        country,
+        system_locale: options?.systemLocale ?? locale,
+        contact_info: options?.contactInfo ?? [],
+        extra_data: options?.extraData ?? {}
+    };
+}
+function createTestSession(options) {
+    return {
+        bot: {
+            id: options?.botId ?? TEST_DEFAULTS.BOT_ID
+        },
+        user: createTestSessionUser(options?.user),
+        organization: options?.organization ?? TEST_DEFAULTS.ORG_NAME,
+        organization_id: options?.organizationId ?? TEST_DEFAULTS.ORG_ID,
+        is_first_interaction: options?.isFirstInteraction ?? false,
+        is_test_integration: options?.isTestIntegration ?? false,
+        _access_token: options?.accessToken ?? TEST_DEFAULTS.ACCESS_TOKEN,
+        _hubtype_api: options?.hubtypeApi ?? TEST_DEFAULTS.HUBTYPE_API_HOST,
+        flow_thread_id: options?.flowThreadId ?? TEST_DEFAULTS.FLOW_THREAD_ID,
+        __retries: options?.retries ?? 0,
+        _shadowing: options?.shadowing,
+        _hubtype_case_id: options?.hubtypeCaseId,
+        capture_user_input: options?.captureUserInputNodeId ? {
+            node_id: options.captureUserInputNodeId
+        } : undefined
+    };
+}
+function createTestInput(options) {
+    return {
+        type: options?.type ?? INPUT.TEXT,
+        data: options?.data,
+        text: options?.text ?? options?.data,
+        payload: options?.payload,
+        src: options?.src,
+        transcript: options?.transcript,
+        context: options?.context,
+        bot_interaction_id: options?.botInteractionId ?? TEST_DEFAULTS.BOT_INTERACTION_ID,
+        message_id: options?.messageId ?? TEST_DEFAULTS.MESSAGE_ID
+    };
+}
+function isFullInput(v) {
+    return 'bot_interaction_id' in v && 'message_id' in v;
+}
+function isFullSession(v) {
+    return 'bot' in v && '__retries' in v;
+}
+function isFullSettings(v) {
+    return 'HUBTYPE_API_URL' in v && 'STATIC_URL' in v && 'LITELLM_API_URL' in v && 'AZURE_OPENAI_API_BASE' in v && 'AZURE_OPENAI_API_VERSION' in v && 'LANGUAGE_DETECTION_ENABLED' in v && 'CUSTOM_SHORT_URL_HOST' in v && 'custom' in v;
+}
+function isFullSecrets(v) {
+    return 'HUBTYPE_ACCESS_TOKEN' in v && 'LITELLM_API_KEY' in v && 'AZURE_OPENAI_API_KEY' in v && 'custom' in v;
+}
+function createTestBotRequest(options) {
+    const input = options?.input == null ? createTestInput() : isFullInput(options.input) ? options.input : createTestInput(options.input);
+    const session = options?.session == null ? createTestSession() : isFullSession(options.session) ? options.session : createTestSession(options.session);
+    const settings = options?.settings == null ? createTestSettings() : isFullSettings(options.settings) ? options.settings : createTestSettings(options.settings);
+    const secrets = options?.secrets == null ? createTestSecrets() : isFullSecrets(options.secrets) ? options.secrets : createTestSecrets(options.secrets);
+    return {
+        input,
+        session,
+        lastRoutePath: options?.lastRoutePath ?? TEST_DEFAULTS.LAST_ROUTE_PATH,
+        settings,
+        secrets
+    };
+}
+function createTestBotContext(options) {
+    const request = createTestBotRequest(options);
+    const sessionForLocale = options?.session == null ? createTestSession() : isFullSession(options.session) ? options.session : createTestSession(options.session);
+    const locale = sessionForLocale.user.locale;
+    const country = sessionForLocale.user.country;
+    const systemLocale = sessionForLocale.user.system_locale;
+    return {
+        ...request,
+        plugins: options?.plugins ?? {},
+        params: options?.params ?? {},
+        defaultDelay: options?.defaultDelay ?? 0,
+        defaultTyping: options?.defaultTyping ?? 0,
+        getUserLocale: ()=>locale,
+        getUserCountry: ()=>country,
+        getSystemLocale: ()=>systemLocale,
+        setUserLocale: ()=>undefined,
+        setUserCountry: ()=>undefined,
+        setSystemLocale: ()=>undefined
+    };
+}
+/**
+ * Alias for `createTestBotContext` typed as `PluginPreRequest`.
+ * PluginPreRequest === BotContext in @botonic/core.
+ */ const createTestPluginPreRequest = createTestBotContext;
+function createTestPluginPostRequest(options) {
+    return {
+        ...createTestBotContext(options),
+        response: options?.response ?? null
+    };
+}
+
+export { TEST_DEFAULTS, createTestBotContext, createTestBotRequest, createTestInput, createTestPluginPostRequest, createTestPluginPreRequest, createTestSecrets, createTestSession, createTestSessionUser, createTestSettings };
+
+//# sourceMappingURL=index.js.map

package/lib/testing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing/index.js","sources":["../../src/testing/index.ts"],"sourcesContent":["import {\n  type BotContext,\n  type BotRequest,\n  type BotSecrets,\n  type BotSettings,\n  type ContactInfo,\n  INPUT,\n  type Input,\n  PROVIDER,\n  type ProviderType,\n  type ResolvedPlugins,\n  type Session,\n  type SessionUser,\n} from '../models'\n\n// ---------------------------------------------------------------------------\n// Default values\n// ---------------------------------------------------------------------------\n\nexport const TEST_DEFAULTS = {\n  HUBTYPE_API_URL: 'https://api.hubtype.com',\n  STATIC_URL: 'https://static.hubtype.com',\n  LITELLM_API_URL: 'https://api.litellm.com',\n  AZURE_OPENAI_API_BASE: 'https://api.openai.com',\n  AZURE_OPENAI_API_VERSION: '2026-02-01',\n  LANGUAGE_DETECTION_ENABLED: true,\n  HUBTYPE_ACCESS_TOKEN: 'testAccessToken', // pragma: allowlist secret\n  LITELLM_API_KEY: 'testLiteLLMAPIKey', // pragma: allowlist secret\n  AZURE_OPENAI_API_KEY: 'testAzureOpenAIAPIKey', // pragma: allowlist secret\n  ACCESS_TOKEN: 'fake_access_token',\n  HUBTYPE_API_HOST: 'https://api.hubtype.com',\n  FLOW_THREAD_ID: 'testFlowThreadId',\n  BOT_ID: 'testBotId',\n  USER_ID: 'testUserId',\n  ORG_ID: 'testOrgId',\n  ORG_NAME: 'testOrg',\n  PROVIDER: PROVIDER.WEBCHAT as ProviderType,\n  LOCALE: 'en',\n  COUNTRY: 'US',\n  BOT_INTERACTION_ID: 'testInteractionId',\n  MESSAGE_ID: 'testMessageId',\n  LAST_ROUTE_PATH: '',\n}\n\n// ---------------------------------------------------------------------------\n// Leaf factories\n// ---------------------------------------------------------------------------\n\nexport function createTestSettings(\n  overrides?: Partial<BotSettings>\n): BotSettings {\n  return {\n    HUBTYPE_API_URL: TEST_DEFAULTS.HUBTYPE_API_URL,\n    STATIC_URL: TEST_DEFAULTS.STATIC_URL,\n    LITELLM_API_URL: TEST_DEFAULTS.LITELLM_API_URL,\n    AZURE_OPENAI_API_BASE: TEST_DEFAULTS.AZURE_OPENAI_API_BASE,\n    AZURE_OPENAI_API_VERSION: TEST_DEFAULTS.AZURE_OPENAI_API_VERSION,\n    LANGUAGE_DETECTION_ENABLED: TEST_DEFAULTS.LANGUAGE_DETECTION_ENABLED,\n    CUSTOM_SHORT_URL_HOST: null,\n    custom: {},\n    ...overrides,\n  }\n}\n\nexport function createTestSecrets(overrides?: Partial<BotSecrets>): BotSecrets {\n  return {\n    HUBTYPE_ACCESS_TOKEN: TEST_DEFAULTS.HUBTYPE_ACCESS_TOKEN,\n    LITELLM_API_KEY: TEST_DEFAULTS.LITELLM_API_KEY,\n    AZURE_OPENAI_API_KEY: TEST_DEFAULTS.AZURE_OPENAI_API_KEY,\n    custom: {},\n    ...overrides,\n  }\n}\n\nexport interface TestUserOptions {\n  id?: string\n  provider?: ProviderType\n  locale?: string\n  country?: string\n  systemLocale?: string\n  contactInfo?: ContactInfo[]\n  extraData?: Record<string, any>\n}\n\nexport function createTestSessionUser(\n  options?: TestUserOptions\n): SessionUser<Record<string, any>> {\n  const locale = options?.locale ?? TEST_DEFAULTS.LOCALE\n  const country = options?.country ?? TEST_DEFAULTS.COUNTRY\n  return {\n    id: options?.id ?? TEST_DEFAULTS.USER_ID,\n    provider: options?.provider ?? TEST_DEFAULTS.PROVIDER,\n    locale,\n    country,\n    system_locale: options?.systemLocale ?? locale,\n    contact_info: options?.contactInfo ?? [],\n    extra_data: options?.extraData ?? {},\n  }\n}\n\nexport interface TestSessionOptions {\n  user?: TestUserOptions\n  botId?: string\n  organization?: string\n  organizationId?: string\n  isFirstInteraction?: boolean\n  isTestIntegration?: boolean\n  accessToken?: string\n  hubtypeApi?: string\n  flowThreadId?: string\n  retries?: number\n  shadowing?: boolean\n  hubtypeCaseId?: string\n  captureUserInputNodeId?: string\n}\n\nexport function createTestSession(\n  options?: TestSessionOptions\n): Session<Record<string, any>> {\n  return {\n    bot: { id: options?.botId ?? TEST_DEFAULTS.BOT_ID },\n    user: createTestSessionUser(options?.user),\n    organization: options?.organization ?? TEST_DEFAULTS.ORG_NAME,\n    organization_id: options?.organizationId ?? TEST_DEFAULTS.ORG_ID,\n    is_first_interaction: options?.isFirstInteraction ?? false,\n    is_test_integration: options?.isTestIntegration ?? false,\n    _access_token: options?.accessToken ?? TEST_DEFAULTS.ACCESS_TOKEN,\n    _hubtype_api: options?.hubtypeApi ?? TEST_DEFAULTS.HUBTYPE_API_HOST,\n    flow_thread_id: options?.flowThreadId ?? TEST_DEFAULTS.FLOW_THREAD_ID,\n    __retries: options?.retries ?? 0,\n    _shadowing: options?.shadowing,\n    _hubtype_case_id: options?.hubtypeCaseId,\n    capture_user_input: options?.captureUserInputNodeId\n      ? { node_id: options.captureUserInputNodeId }\n      : undefined,\n  }\n}\n\nexport interface TestInputOptions {\n  type?: Input['type']\n  data?: string\n  text?: string\n  payload?: string\n  src?: string\n  botInteractionId?: string\n  messageId?: string\n  context?: Input['context']\n  transcript?: string\n}\n\nexport function createTestInput(options?: TestInputOptions): Input {\n  return {\n    type: options?.type ?? INPUT.TEXT,\n    data: options?.data,\n    text: options?.text ?? options?.data,\n    payload: options?.payload,\n    src: options?.src,\n    transcript: options?.transcript,\n    context: options?.context,\n    bot_interaction_id:\n      options?.botInteractionId ?? TEST_DEFAULTS.BOT_INTERACTION_ID,\n    message_id: options?.messageId ?? TEST_DEFAULTS.MESSAGE_ID,\n  }\n}\n\n// ---------------------------------------------------------------------------\n// Composite factories\n// ---------------------------------------------------------------------------\n\nexport interface TestBotRequestOptions {\n  input?: TestInputOptions | Input\n  session?: TestSessionOptions | Session\n  lastRoutePath?: string\n  settings?: Partial<BotSettings> | BotSettings\n  secrets?: Partial<BotSecrets> | BotSecrets\n}\n\nfunction isFullInput(v: TestInputOptions | Input): v is Input {\n  return 'bot_interaction_id' in v && 'message_id' in v\n}\n\nfunction isFullSession(v: TestSessionOptions | Session): v is Session {\n  return 'bot' in v && '__retries' in v\n}\n\nfunction isFullSettings(\n  v: Partial<BotSettings> | BotSettings\n): v is BotSettings {\n  return (\n    'HUBTYPE_API_URL' in v &&\n    'STATIC_URL' in v &&\n    'LITELLM_API_URL' in v &&\n    'AZURE_OPENAI_API_BASE' in v &&\n    'AZURE_OPENAI_API_VERSION' in v &&\n    'LANGUAGE_DETECTION_ENABLED' in v &&\n    'CUSTOM_SHORT_URL_HOST' in v &&\n    'custom' in v\n  )\n}\n\nfunction isFullSecrets(v: Partial<BotSecrets> | BotSecrets): v is BotSecrets {\n  return (\n    'HUBTYPE_ACCESS_TOKEN' in v &&\n    'LITELLM_API_KEY' in v &&\n    'AZURE_OPENAI_API_KEY' in v &&\n    'custom' in v\n  )\n}\n\nexport function createTestBotRequest(\n  options?: TestBotRequestOptions\n): BotRequest {\n  const input =\n    options?.input == null\n      ? createTestInput()\n      : isFullInput(options.input)\n        ? options.input\n        : createTestInput(options.input)\n\n  const session =\n    options?.session == null\n      ? createTestSession()\n      : isFullSession(options.session)\n        ? options.session\n        : createTestSession(options.session)\n\n  const settings =\n    options?.settings == null\n      ? createTestSettings()\n      : isFullSettings(options.settings)\n        ? options.settings\n        : createTestSettings(options.settings)\n\n  const secrets =\n    options?.secrets == null\n      ? createTestSecrets()\n      : isFullSecrets(options.secrets)\n        ? options.secrets\n        : createTestSecrets(options.secrets)\n\n  return {\n    input,\n    session,\n    lastRoutePath: options?.lastRoutePath ?? TEST_DEFAULTS.LAST_ROUTE_PATH,\n    settings,\n    secrets,\n  }\n}\n\nexport interface TestBotContextOptions<\n  TPlugins extends ResolvedPlugins = ResolvedPlugins,\n> extends TestBotRequestOptions {\n  plugins?: TPlugins\n  params?: Record<string, string>\n  defaultDelay?: number\n  defaultTyping?: number\n}\n\nexport function createTestBotContext<\n  TPlugins extends ResolvedPlugins = ResolvedPlugins,\n>(options?: TestBotContextOptions<TPlugins>): BotContext<TPlugins> {\n  const request = createTestBotRequest(options)\n\n  const sessionForLocale =\n    options?.session == null\n      ? createTestSession()\n      : isFullSession(options.session)\n        ? options.session\n        : createTestSession(options.session)\n\n  const locale = sessionForLocale.user.locale\n  const country = sessionForLocale.user.country\n  const systemLocale = sessionForLocale.user.system_locale\n\n  return {\n    ...request,\n    plugins: options?.plugins ?? ({} as TPlugins),\n    params: options?.params ?? {},\n    defaultDelay: options?.defaultDelay ?? 0,\n    defaultTyping: options?.defaultTyping ?? 0,\n    getUserLocale: () => locale,\n    getUserCountry: () => country,\n    getSystemLocale: () => systemLocale,\n    setUserLocale: () => undefined,\n    setUserCountry: () => undefined,\n    setSystemLocale: () => undefined,\n  }\n}\n\n/**\n * Alias for `createTestBotContext` typed as `PluginPreRequest`.\n * PluginPreRequest === BotContext in @botonic/core.\n */\nexport const createTestPluginPreRequest = createTestBotContext\n\nexport interface TestPluginPostRequestOptions<\n  TPlugins extends ResolvedPlugins = ResolvedPlugins,\n> extends TestBotContextOptions<TPlugins> {\n  response?: string | null\n}\n\nexport function createTestPluginPostRequest<\n  TPlugins extends ResolvedPlugins = ResolvedPlugins,\n>(\n  options?: TestPluginPostRequestOptions<TPlugins>\n): BotContext<TPlugins> & { response: string | null } {\n  return {\n    ...createTestBotContext(options),\n    response: options?.response ?? null,\n  }\n}\n"],"names":["INPUT","PROVIDER","TEST_DEFAULTS","createTestSettings","overrides","createTestSecrets","createTestSessionUser","options","locale","country","createTestSession","undefined","createTestInput","isFullInput","v","isFullSession","isFullSettings","isFullSecrets","createTestBotRequest","input","session","settings","secrets","createTestBotContext","request","sessionForLocale","systemLocale","createTestPluginPreRequest","createTestPluginPostRequest"],"mappings":";;;AAakB;AAElB,8EAA8E;AAC9E,iBAAiB;AACjB,8EAA8E;AAEvE,MAAME,aAAaA,GAAG;IAC3B,iBAAiB;IACjB,YAAY;IACZ,iBAAiB;IACjB,uBAAuB;IACvB,0BAA0B;IAC1B,4BAA4B;IAC5B,sBAAsB;IACtB,iBAAiB;IACjB,sBAAsB;IACtB,cAAc;IACd,kBAAkB;IAClB,gBAAgB;IAChB,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,UAAU;IACV,UAAUD,gBAAgB;IAC1B,QAAQ;IACR,SAAS;IACT,oBAAoB;IACpB,YAAY;IACZ,iBAAiB;AACnB,EAAC;AAED,8EAA8E;AAC9E,iBAAiB;AACjB,8EAA8E;AAEvE,SAASE,kBAAkBA,CAChCC,SAAgC;IAEhC,OAAO;QACL,iBAAiBF,aAAaA,CAAC,eAAe;QAC9C,YAAYA,aAAaA,CAAC,UAAU;QACpC,iBAAiBA,aAAaA,CAAC,eAAe;QAC9C,uBAAuBA,aAAaA,CAAC,qBAAqB;QAC1D,0BAA0BA,aAAaA,CAAC,wBAAwB;QAChE,4BAA4BA,aAAaA,CAAC,0BAA0B;QACpE,uBAAuB;QACvB,QAAQ,CAAC;QACT,GAAGE,SAAS;IACd;AACF;AAEO,SAASC,iBAAiBA,CAACD,SAA+B;IAC/D,OAAO;QACL,sBAAsBF,aAAaA,CAAC,oBAAoB;QACxD,iBAAiBA,aAAaA,CAAC,eAAe;QAC9C,sBAAsBA,aAAaA,CAAC,oBAAoB;QACxD,QAAQ,CAAC;QACT,GAAGE,SAAS;IACd;AACF;AAYO,SAASE,qBAAqBA,CACnCC,OAAyB;IAEzB,MAAMC,SAASD,SAAS,UAAUL,aAAaA,CAAC,MAAM;IACtD,MAAMO,UAAUF,SAAS,WAAWL,aAAaA,CAAC,OAAO;IACzD,OAAO;QACL,IAAIK,SAAS,MAAML,aAAaA,CAAC,OAAO;QACxC,UAAUK,SAAS,YAAYL,aAAaA,CAAC,QAAQ;QACrDM;QACAC;QACA,eAAeF,SAAS,gBAAgBC;QACxC,cAAcD,SAAS,eAAe,EAAE;QACxC,YAAYA,SAAS,aAAa,CAAC;IACrC;AACF;AAkBO,SAASG,iBAAiBA,CAC/BH,OAA4B;IAE5B,OAAO;QACL,KAAK;YAAE,IAAIA,SAAS,SAASL,aAAaA,CAAC,MAAM;QAAC;QAClD,MAAMI,qBAAqBA,CAACC,SAAS;QACrC,cAAcA,SAAS,gBAAgBL,aAAaA,CAAC,QAAQ;QAC7D,iBAAiBK,SAAS,kBAAkBL,aAAaA,CAAC,MAAM;QAChE,sBAAsBK,SAAS,sBAAsB;QACrD,qBAAqBA,SAAS,qBAAqB;QACnD,eAAeA,SAAS,eAAeL,aAAaA,CAAC,YAAY;QACjE,cAAcK,SAAS,cAAcL,aAAaA,CAAC,gBAAgB;QACnE,gBAAgBK,SAAS,gBAAgBL,aAAaA,CAAC,cAAc;QACrE,WAAWK,SAAS,WAAW;QAC/B,YAAYA,SAAS;QACrB,kBAAkBA,SAAS;QAC3B,oBAAoBA,SAAS,yBACzB;YAAE,SAASA,QAAQ,sBAAsB;QAAC,IAC1CI;IACN;AACF;AAcO,SAASC,eAAeA,CAACL,OAA0B;IACxD,OAAO;QACL,MAAMA,SAAS,QAAQP,UAAU;QACjC,MAAMO,SAAS;QACf,MAAMA,SAAS,QAAQA,SAAS;QAChC,SAASA,SAAS;QAClB,KAAKA,SAAS;QACd,YAAYA,SAAS;QACrB,SAASA,SAAS;QAClB,oBACEA,SAAS,oBAAoBL,aAAaA,CAAC,kBAAkB;QAC/D,YAAYK,SAAS,aAAaL,aAAaA,CAAC,UAAU;IAC5D;AACF;AAcA,SAASW,WAAWA,CAACC,CAA2B;IAC9C,OAAO,wBAAwBA,KAAK,gBAAgBA;AACtD;AAEA,SAASC,aAAaA,CAACD,CAA+B;IACpD,OAAO,SAASA,KAAK,eAAeA;AACtC;AAEA,SAASE,cAAcA,CACrBF,CAAqC;IAErC,OACE,qBAAqBA,KACrB,gBAAgBA,KAChB,qBAAqBA,KACrB,2BAA2BA,KAC3B,8BAA8BA,KAC9B,gCAAgCA,KAChC,2BAA2BA,KAC3B,YAAYA;AAEhB;AAEA,SAASG,aAAaA,CAACH,CAAmC;IACxD,OACE,0BAA0BA,KAC1B,qBAAqBA,KACrB,0BAA0BA,KAC1B,YAAYA;AAEhB;AAEO,SAASI,oBAAoBA,CAClCX,OAA+B;IAE/B,MAAMY,QACJZ,SAAS,SAAS,OACdK,eAAeA,KACfC,WAAWA,CAACN,QAAQ,KAAK,IACvBA,QAAQ,KAAK,GACbK,eAAeA,CAACL,QAAQ,KAAK;IAErC,MAAMa,UACJb,SAAS,WAAW,OAChBG,iBAAiBA,KACjBK,aAAaA,CAACR,QAAQ,OAAO,IAC3BA,QAAQ,OAAO,GACfG,iBAAiBA,CAACH,QAAQ,OAAO;IAEzC,MAAMc,WACJd,SAAS,YAAY,OACjBJ,kBAAkBA,KAClBa,cAAcA,CAACT,QAAQ,QAAQ,IAC7BA,QAAQ,QAAQ,GAChBJ,kBAAkBA,CAACI,QAAQ,QAAQ;IAE3C,MAAMe,UACJf,SAAS,WAAW,OAChBF,iBAAiBA,KACjBY,aAAaA,CAACV,QAAQ,OAAO,IAC3BA,QAAQ,OAAO,GACfF,iBAAiBA,CAACE,QAAQ,OAAO;IAEzC,OAAO;QACLY;QACAC;QACA,eAAeb,SAAS,iBAAiBL,aAAaA,CAAC,eAAe;QACtEmB;QACAC;IACF;AACF;AAWO,SAASC,oBAAoBA,CAElChB,OAAyC;IACzC,MAAMiB,UAAUN,oBAAoBA,CAACX;IAErC,MAAMkB,mBACJlB,SAAS,WAAW,OAChBG,iBAAiBA,KACjBK,aAAaA,CAACR,QAAQ,OAAO,IAC3BA,QAAQ,OAAO,GACfG,iBAAiBA,CAACH,QAAQ,OAAO;IAEzC,MAAMC,SAASiB,iBAAiB,IAAI,CAAC,MAAM;IAC3C,MAAMhB,UAAUgB,iBAAiB,IAAI,CAAC,OAAO;IAC7C,MAAMC,eAAeD,iBAAiB,IAAI,CAAC,aAAa;IAExD,OAAO;QACL,GAAGD,OAAO;QACV,SAASjB,SAAS,WAAY,CAAC;QAC/B,QAAQA,SAAS,UAAU,CAAC;QAC5B,cAAcA,SAAS,gBAAgB;QACvC,eAAeA,SAAS,iBAAiB;QACzC,eAAe,IAAMC;QACrB,gBAAgB,IAAMC;QACtB,iBAAiB,IAAMiB;QACvB,eAAe,IAAMf;QACrB,gBAAgB,IAAMA;QACtB,iBAAiB,IAAMA;IACzB;AACF;AAEA;;;CAGC,GACM,MAAMgB,0BAA0BA,GAAGJ,oBAAoBA,CAAA;AAQvD,SAASK,2BAA2BA,CAGzCrB,OAAgD;IAEhD,OAAO;QACL,GAAGgB,oBAAoBA,CAAChB,QAAQ;QAChC,UAAUA,SAAS,YAAY;IACjC;AACF"}

package/lib/{cjs/utils → utils}/bot-config.d.ts

@@ -1,4 +1,4 @@
 import { type ZodType } from 'zod';
-import { type VariableConfigJSON } from '../models/index';
+import { type VariableConfigJSON } from '../models/index.js';
 export declare const BASE_SESSION_VARIABLES: VariableConfigJSON[];
 export declare function getSessionVariables(extraDataSchema?: ZodType): VariableConfigJSON[];