Routing Package

github.com/mbvlabs/andurel/pkg/routing provides typed route values for constructing paths and URLs. It does not register Echo handlers or select HTTP methods; generated files in router/routes declare route values, while router.Router binds them to controllers and middleware.

Route declarations

A route stores its local path, name, optional prefix, and whether it should appear in generated Inertia helpers.

1var ProductsIndex = routing.NewSimpleRoute("", "index", "/products")
2var ProductShow = routing.NewRouteWithUUIDID(
3    "/:id", "show", "/products", routing.InertiaRoute(),
4)

Path() returns the Echo registration path, Name() returns the prefixed name, URL(...) substitutes typed parameters, and FullURL(base, ...) prepends the application base URL. Central declarations prevent links, redirects, and tests from duplicating strings.

Typed parameter routes

Multiple parameters use a struct so call sites cannot swap same-typed values:

1type ProjectParams struct {
2    Team    string `param:"team"`
3    Project string `param:"project"`
4}
5var ProjectShow = routing.NewRouteWithParams[ProjectParams](
6    "/:team/projects/:project", "show", "projects",
7)
8url := ProjectShow.URL(ProjectParams{Team: "platform", Project: "orbit"})

The generic route substitutes tagged string fields. A non-struct input returns an empty URL. Prefer dedicated constructors for numeric and UUID IDs.

Prefixes and normalization

Prefixes affect path and name. Joining tolerates a missing or doubled slash and logs a warning before normalization. Paths are trimmed, backslashes converted, embedded query strings and fragments removed, double slashes collapsed, a leading slash added, and trailing slashes removed except for /.

Normalization is a guardrail. Declare canonical paths so warnings reveal mistakes rather than becoming routine output.

Query parameters and full URLs

QueryParam appends query values; FullURL combines a route with config.App.BaseURL:

1next := ProductsIndex.URL(routing.QueryParam("page", "2"))
2absolute := ProductShow.FullURL(app.BaseURL, product.ID)

Values are appended as supplied, so encode arbitrary input before passing it. Route declarations should not include query strings or fragments.

Inertia TypeScript generation

InertiaRoute() marks a route for andurel generate routes, which writes typed helpers to resources/js/routes.ts. Opt-in avoids exporting internal endpoints or assets into the browser bundle. JsExpr marks a JavaScript expression for generator interpolation; it is not a general escaping function.

After changing a marked route, regenerate helpers and compile the frontend. A parameter or path change is a cross-boundary API change.

Registration boundary

The package does not verify registration, attach middleware, reverse-match requests, or parse Echo parameters. Register route.Path() with the intended method and parse request parameters in controllers. Important route tests should cover both URL construction and router registration.