Ability to manually register non-discoverable routes

[jackfrosty908]

I may have missed something in the docs, but is there a way to manually register routes?

Issue I'm facing

I am using next-typesafe-url in a project that serves a single-page application (the TinaCMS admin UI) from the /public directory. The route to access this application is /admin/index.html.

Because this path is served as a static asset from the public folder, it is not part of the Next.js routing system that next-typesafe-url's CLI scans. As a result, this route is not included in the generated types, and I cannot use the $path function to create type-safe links to it.

It would be fantastic to have a way to manually register additional routes that the CLI cannot discover automatically. A possible implementation could be a configuration file (e.g., typesafe-url.config.ts) where users can define an array of custom static or dynamic routes.

A super rough idea:

Have a way to manually register additional routes that the CLI cannot discover automatically. A possible implementation could be a configuration file (e.g., typesafe-url.config.ts) where users can define an array of custom static or dynamic routes.

For example:

// typesafe-url.config.ts
import { z } from "zod";

export default {
  /**
   * Manually define routes that are not discoverable by the CLI.
   */
  manualRoutes: {
    // For static routes in /public
    "/admin/index.html": {
        // This would be treated as a StaticRoute
    },
    // Could also potentially support defining schemas for external dynamic routes
    "/external-blog/:slug": {
      routeParams: z.object({ slug: z.string() })
    }
  }
};

The CLI could then read this configuration and merge these manualRoutes with the routes it discovers from the file system to create a complete routing map.

[ethanniser]

sorry I didnt see this until now
this is a cool idea

my thoughts on the example are:

• should have a type for this config- either satisfies or a defineConfig function thats types
• these should be called like "externalRoutes" and be kept in a different type in the type gen file and only show up in $path and not in the drop downs for the pageprop types for example

open to prs!

[jackfrosty908]

open to prs!

Awesome, I'm hoping to have some time this week to have a go at this.

Edit: Sorry haven't forgotten about this, have just had other work take priority. Ill get around to this when I can.

[ethanniser]

also like other tools (prettier, eslint, tsup, vitest, etc)
the config should support all existing cli options

[JasonPaff]

@jackfrosty908 If you haven't taken a crack at this yet I would be open to taking on the work myself. I use this library on multiple projects at work and a config file would be nice addition to it.

Edit: (the config file portion, not the registering non-discoverable routes but the route feature would be easier to add once the config file functionality exists).

[jackfrosty908]

@JasonPaff That would be great. I haven't freed up enough time to have a go at it yet.

[JasonPaff]

@jackfrosty908 @ethanniser PR for the config file support is up. Added tests and an example project for it too. Would love to get some other eyes on it to tell me what I missed.