eden/treaty/overview

[giscus[bot]]

eden/treaty/overview

A VitePress site

https://elysiajs.com/eden/treaty/overview

[ToxicalNoob3062]

what about /:param1/:param2 ? Eden treaty doesn't work for that i think.

[caiolandgraf]

// server.ts
import { Elysia } from 'elysia'

const app = new Elysia()
  // ❌ Problems with Eden Treaty
  .get('/bad/:param1/:param2', ({ params }) => params)
  
  // ✅ Works great with Eden Treaty
  .get('/good/:id/details/:detailId', ({ params }) => params)
  
  // ✅ Alternative with query
  .get('/query', ({ query }) => query)
  
  .listen(3000)

export type App = typeof app

// client.ts
import { treaty } from '@elysiajs/eden'
import type { App } from './server'

const client = treaty<App>('localhost:3000')

// ✅ Works
const good = await client.good[123].details[456].get()

// ✅ Works
const query = await client.query.get({
  query: { param1: 'a', param2: 'b' }
})

I think that maybe this solve yours questions

[caiolandgraf]

I'm sorry, I test in my code now and I fix this...

const good = await api.good({
  id: "123",
}).details({
  detailId: "456",
}).get()

[ToxicalNoob3062]

thanks man! Thats an elegant solve around for that tricky problem. Cool. 😎

[julioflima]

This seams work well in monorepos. But there is any possibility to fetch this, like we do with types in graphql?

[michaelthreekiv]

You can create a package with types from your repository and install it on your client

[LucasBonafe]

@michaelthreekiv, do you have some example?

[michaelthreekiv]

@LucasBonafe In my projects I use monorepo and import server type directly, but you can use this link - https://docs.npmjs.com/creating-and-publishing-private-packages

[daviziks]

Hey folks, what about if the elysia backend is on another repo?
I saw the suggestion about a separated type package but it's more difficult when front-end have a typecheck CI that depends on a feature implemented in the other repo that stills in a PR.

[Thanyanit-J]

This may help.
https://github.com/rayriffy/elysia-remote-dts

[zxdev7]

What should I do if I want to use Eden Treaty in a multi-repository setup following best practices, where the frontend and backend are deployed on separate cloud environments?

├── backend/ ← Backend repository
│ ├── src/
│ │ ├── modules/
│ │ │ └── auth/
│ │ │ ├── index.ts
│ │ │ ├── model.ts
│ │ │ └── service.ts
│ │ ├── utils/
│ │ │ ├── oauth.ts
│ │ │ ├── prisma.ts
│ │ │ ├── tenant.ts
│ │ │ └── turnstile.ts
│ │ └── index.ts
│ ├── prisma/
│ │ └── schema.prisma
│ ├── package.json
│ ├── tsconfig.json
│ └── .env
├── frontend/ ← Frontend repository
│ ├── app/
│ │ ├── favicon.ico
│ │ ├── globals.css
│ │ ├── layout.tsx
│ │ └── page.tsx
│ ├── lib/
│ │ ├── eden.ts ← (Type Synchronization Setup)
│ │ └── utils.ts
│ ├── public/
│ ├── package.json
│ ├── tsconfig.json
│ └── next.config.ts

[zxdev7]

https://github.com/rayriffy/elysia-remote-dts

[Kakaique2000]

I'd like to add a tip here, if you're trying to use Elysia in a monorepo with a vite app as the client, DON'T export your types on the same file you define your API (generally index.ts). Always something like "type.ts" where you have something like:

type.ts

import type { app } from "./index";
export type App = typeof app;

package.json

{
   "...": "rest",
   "exports": {
      ".": "./src/type.ts"
    }
}

The reason for that is that at the moment of resolving modules for the frontend, the bundler might end up trying to resolve the runtime modules of your backend, that's not a problem all the time but if you use something like google-auth-library it will try to execute stuff on the module resolution phase and will try to call process on your frontend code.

[Kakaique2000]

You don't actually have to do that, the only thing you need to be aware is to use the right import statement:

import { type App } from '@test/api'  // NOT safe, it will try to resolve the backend modules and it might crash

import type { App } from "@test/api" // This works because the import is purely a type import

Nonetheless, it is a good practice to only expose types from your backend module, you generally don't want to bring the backend logic to your frontend application as that is a security vulnerability (potentially exposing backend code on frontend).

[lbonafe-codezi]

@Kakaique2000, do you have any 'tsconfig.json' settings that force the correct use of import?

Today I use one that makes it necessary to specify that it is a 'type', but not outside the curly brackets...