burger-api/dist/src/utils/routing.js

<p align="center"> <img src="https://github.com/user-attachments/assets/0d9b376e-1d89-479a-aa7f-e7ee3c6b2342" alt="BurgerAPI logo"/> </p>

/**
 * Constants for route handling.
 */
export const ROUTE_CONSTANTS = {
    SUPPORTED_PAGE_EXTENSIONS: ['.tsx', '.html'],
    PAGE_INDEX_FILES: ['index.tsx', 'index.html'],
    DYNAMIC_SEGMENT_PREFIX: ':',
    DYNAMIC_FOLDER_START: '[',
    DYNAMIC_FOLDER_END: ']',
    GROUPING_FOLDER_START: '(',
    GROUPING_FOLDER_END: ')',
};
/**
 * Supported HTTP methods
 */
export const HTTP_METHODS = [
    'GET',
    'POST',
    'PUT',
    'DELETE',
    'PATCH',
    'HEAD',
    'OPTIONS',
];
/**
 * Calculates the specificity of a route path based on the number of static segments.
 * Static segments increase the score, while dynamic segments (:param) do not.
 * @param path The route path to evaluate.
 * @returns The specificity score (higher means more static segments).
 */
export const getRouteSpecificity = (path) => {
    const segments = path.split('/').filter(Boolean);
    return segments.reduce((score, segment) => {
        return segment.startsWith(ROUTE_CONSTANTS.DYNAMIC_SEGMENT_PREFIX)
            ? score
            : score + 1;
    }, 0);
};
/**
 * Compares two routes for sorting, prioritizing those with higher specificity (more static segments).
 * If specificity is equal, sorts alphabetically by path.
 * @param a The first route to compare.
 * @param b The second route to compare.
 * @returns Negative if a comes before b, positive if b comes before a, zero if equal.
 */
export const compareRoutes = (a, b) => {
    const aSpecificity = getRouteSpecificity(a.path);
    const bSpecificity = getRouteSpecificity(b.path);
    if (aSpecificity > bSpecificity)
        return -1;
    if (aSpecificity < bSpecificity)
        return 1;
    return a.path.localeCompare(b.path);
};
/**
 * Collects all routes from the trie and returns them as an array of RouteDefinition objects.
 * @param node The current node in the trie.
 * @param currentPath The current path being traversed.
 * @param routes The array of collected routes.
 * @returns An array of RouteDefinition objects.
 */
export function collectRoutes(node, currentPath = '', routes = []) {
    // If this node has a route definition, add it
    if (node.route) {
        routes.push({
            ...node.route,
            path: currentPath,
        });
    }
    // Traverse static children
    node.children.forEach((child, segment) => {
        collectRoutes(child, `${currentPath}/${segment}`, routes);
    });
    // Traverse dynamic child if exists
    if (node.paramChild) {
        const paramPath = `${currentPath}/:${node.paramChild.paramName}`;
        collectRoutes(node.paramChild, paramPath, routes);
    }
    return routes;
}