Remote Function Endpoints (+remote.ts)

[sillvva]

In a discussion on Discord the other day, I had an idea for remote function endpoints that would supplement existing remote function features. In addition to the something.remote.ts files that you can use in $lib/ or src/routes/ already, the idea would be the ability to create +remote.ts files in src/routes/ that generate actual endpoints.

So for example:

src/routes
└─ remote
  └─ users
    └─ +remote.ts
      └─ export const getOne = query()
      └─ export const getAll = query()

Results in endpoints like

GET /remote/users/getOne
GET /remote/users/getAll

For input, the URL parameters or POST body would be validated against the validation library.

So ?name=John&role=user, would be validated against something like:

v.partial(v.object({
  id: v.number(),
  name: v.string(),
  role: v.picklist(["user", "admin"])
}))

And of course, you could still use the functions from this file like any other remote function. The only other difference would be that these functions do have a route id.

[realfakenerd]

That'll be nice to have, but why have this if the remote functions are meant to be used as functions in your template?

[sillvva]

That is true, but it's possible you might want to expose some to third parties like an API. You could technically call them from a +server.ts, but that is just extra boilerplate as you would have to create separate directories and files for every endpoint.

[realfakenerd]

Expose some to third parties? Like creating a lib with your functions? Or using it inside +server.ts?

[sillvva]

It would sort of be like an alternative to +server.ts, the way remote functions are intended to be an alternative to load and actions.