paramour 0.10.0 → 0.11.0

package/dist/describe.d.ts

@@ -45,6 +45,11 @@ export interface RouteDescription {
     readonly path: string;
     readonly router: RouterKind;
     readonly search: SearchDescription;
+    /**
+     * Present (and `true`) only for a route defined with `trailingSlash: true`,
+     * so descriptions of R6-default routes are unchanged.
+     */
+    readonly trailingSlash?: true;
 }
 /**
  * The `search:` slot's three shapes: absent config, a codec map, or the

package/dist/describe.js

@@ -59,6 +59,7 @@ export function describeRoute(route) {
         path: route.path,
         router: route["~router"],
         search: describeSearch(route["~search"]),
+        ...(route["~trailingSlash"] ? { trailingSlash: true } : {}),
     };
 }
 /**

package/dist/path.d.ts

@@ -61,6 +61,15 @@ export type PathSegment = {
  * joined with `/`. R2's element joining falls out of the same join as
  * everything else; a fully-elided path (an optional catch-all at the root)
  * yields "/".
+ *
+ * R6's one exception lives here, not in href, so `buildPath` and `href`
+ * always agree on the path: a route defined with `trailingSlash: true` gets a
+ * "/" after its last segment. The slash goes on the BUILT path, after any
+ * elision, so an elided optional catch-all yields "/docs/" and the root stays
+ * "/" rather than "//". It is a route-definition fact, not a Next config read,
+ * because route modules also run where no Next config exists (a CLI printing
+ * absolute links); a static export with `trailingSlash: true` serves exactly
+ * these URLs without a redirect.
  */
 export declare function buildPath<R extends AnyRoute>(route: R, params: InferParamsInput<R>): string;
 /**

package/dist/path.js

@@ -13,9 +13,19 @@ const GROUP_SEGMENT = /^\(.*\)$/;
  * joined with `/`. R2's element joining falls out of the same join as
  * everything else; a fully-elided path (an optional catch-all at the root)
  * yields "/".
+ *
+ * R6's one exception lives here, not in href, so `buildPath` and `href`
+ * always agree on the path: a route defined with `trailingSlash: true` gets a
+ * "/" after its last segment. The slash goes on the BUILT path, after any
+ * elision, so an elided optional catch-all yields "/docs/" and the root stays
+ * "/" rather than "//". It is a route-definition fact, not a Next config read,
+ * because route modules also run where no Next config exists (a CLI printing
+ * absolute links); a static export with `trailingSlash: true` serves exactly
+ * these URLs without a redirect.
  */
 export function buildPath(route, params) {
-    return `/${encodeParams(route, params).join("/")}`;
+    const path = `/${encodeParams(route, params).join("/")}`;
+    return route["~trailingSlash"] && path !== "/" ? `${path}/` : path;
 }
 /**
  * Decodes a params source against a route's codecs, the sync twin of
@@ -308,7 +318,9 @@ export function tokenizePath(path) {
         throw new ParamourError(`route path must start with "/": "${path}"`);
     }
     if (path !== "/" && path.endsWith("/")) {
-        throw new ParamourError(`route path must not end with "/": "${path}"`);
+        // The literal is the route's identity (registry key, Href brand), so it
+        // never carries the slash; the built URL can, via the define option.
+        throw new ParamourError(`route path must not end with "/": "${path}" (to build links with a trailing slash, pass trailingSlash: true in the route config)`);
     }
     if (path === "/")
         return [];

package/dist/route.d.ts

@@ -226,17 +226,26 @@ export interface Route<Path extends string, PC extends ParamsConfig<Path>, SC ex
      * registry — tree-shaking is untouched.
      */
     readonly "~segments": readonly PathSegment[];
+    /**
+     * The define-time `trailingSlash` option (R6's exception): `buildPath`, and
+     * so `href`, append "/" to every non-root path when true. Required, not
+     * optional: an optional member here turns the wrong-router diagnostics
+     * (an AppRoute passed where AnyPagesRoute is expected) into
+     * exactOptionalPropertyTypes noise. Readers test it for truthiness, so a
+     * plain-JS hand-built route without it gets the R6 default.
+     */
+    readonly "~trailingSlash": boolean;
 }
 /**
  * Conditional on the path shape: dynamic paths REQUIRE `params` with exactly
  * the extracted segment names; static paths REJECT it (`?: never` — may be
  * absent, may never be present, which under exactOptionalPropertyTypes holds
- * even for non-fresh objects).
+ * even for non-fresh objects). `trailingSlash` is the same on both branches.
  */
-export type RouteConfig<Path extends string, PC extends ParamsConfig<Path>, SC extends SearchSlot> = [PathParamNames<Path>] extends [never] ? {
+export type RouteConfig<Path extends string, PC extends ParamsConfig<Path>, SC extends SearchSlot> = [PathParamNames<Path>] extends [never] ? TrailingSlashOption & {
     readonly params?: never;
     readonly search?: SC;
-} : {
+} : TrailingSlashOption & {
     readonly params: ConformParams<Path, PC>;
     readonly search?: SC;
 };
@@ -310,6 +319,19 @@ type PresentRegisteredPaths = (ParamourRegister extends {
  * and decode expectations, so it is excluded here.
  */
 type StaticPathsOf<P extends string> = P extends `${string}[${string}` ? never : P;
+/**
+ * The route-config option behind R6's exception. Not exported on its own:
+ * it is part of {@link RouteConfig}, the type wrappers should name.
+ */
+interface TrailingSlashOption {
+    /**
+     * Build every non-root path with a trailing slash: `/asset/`,
+     * `/docs/a/b/`, `/asset/?q=1#top`; the root stays `/`. Set it to match
+     * `trailingSlash` in `next.config` (`paramour doctor` warns when they
+     * disagree). Defaults to `false`, wire-format rule R6.
+     */
+    readonly trailingSlash?: boolean;
+}
 /**
  * Defines an App Router route: the URL-shaped path literal plus its
  * param/search codec configs. Validates the literal eagerly — fail-fast at

package/dist/route.js

@@ -161,13 +161,19 @@ async function rebrandRejection(promise) {
  */
 function routeData(router, path, config) {
     const segments = tokenizePath(path);
-    const { params, search } = config;
+    const { params, search, trailingSlash } = config;
+    // Plain-JS backstop, fail-fast like the literal checks: a truthy string
+    // ("false") read loosely would silently change every link the route builds.
+    if (trailingSlash !== undefined && typeof trailingSlash !== "boolean") {
+        throw new ParamourError(`route "${path}": trailingSlash must be a boolean, got ${describeType(trailingSlash)}`);
+    }
     return {
         path,
         "~params": params ?? {},
         "~router": router,
         "~search": search ?? {},
         "~segments": segments,
+        "~trailingSlash": trailingSlash ?? false,
     };
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "paramour",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "type": "module",
   "exports": {
     ".": {