@equinor/fusion-framework-vite-plugin-api-service/dist/esm/create-route-matcher.js

Vite plugin for proxying service discovery and mocking

import pathToRegexp from 'path-to-regexp';
/**
 * Creates a route matcher function based on the provided API route definition.
 *
 * This utility supports two types of matching strategies:
 * - **String pattern matching:** If `route.match` is a string, it is interpreted as a
 *   {@link https://www.npmjs.com/package/path-to-regexp | path-to-regexp} pattern. The generated matcher
 *   will extract dynamic parameters from the path and return them as an object if the path matches.
 * - **Custom matcher function:** If `route.match` is a function, it is used directly as the matcher,
 *   allowing for advanced or custom matching logic that can utilize both the path and the request object.
 *
 * @typeParam T - The type of request parameters to extract from the path, extending `RequestParams`.
 * @param route - The API route definition, which specifies either a string pattern or a custom matcher function.
 * @returns A matcher function that takes a path and request, returning either a boolean or an object containing extracted parameters.
 *
 * @example
 * // Using a string pattern to extract parameters:
 * const matcher = createRouteMatcher<{ id: string }>({ match: '/user/:id' });
 * const result = matcher('/user/42', req); // { params: { id: '42' } }
 *
 * @example
 * // Using a custom matcher function:
 * const customMatcher = createRouteMatcher(
 *   { match: (path, req) => path === '/health' && req.method === 'GET' }
 * );
 * const result = customMatcher('/health', req); // true
 */
export function createRouteMatcher(route) {
    // extract the match patterns, if string wrap it to array
    const match = typeof route.match === 'string' ? [route.match] : route.match;
    if (Array.isArray(match)) {
        // create a path-to-regexp matcher for each pattern
        return (path) => {
            for (const pattern of match) {
                const result = pathToRegexp.match(pattern)(path);
                if (result) {
                    return result;
                }
            }
            // no match found
            return false;
        };
    }
    return match;
}
//# sourceMappingURL=create-route-matcher.js.map