Hono•4mo ago•

27 replies

RPC, nested routing and types

Hi everyone, quick question given the attached example:
- How do you avoid losing RPC typing when doing nested routing with different routes? Example

/api/stores/:storeId/products

/api/stores/:storeId/products

. The storeId is not required in RPC because

productsCollectionRoutes

productsCollectionRoutes

doesn't have the routing context of

storesRoutes

storesRoutes

.
- It would be less verbose to declare routes with :id instead of :productId, but I guess that's wouldn't work in RPC as I would have two

id

id

s?

As you can see, I have different routes like:
GET

/api/stores/:storeId

/api/stores/:storeId

--> get store
GET/POST

/api/stores/:storeId/products

/api/stores/:storeId/products

--> get or create products for a store
GET/PATCH/DELETE

/api/products/:productId

/api/products/:productId

--> get, update or delete a specific product

// api.ts
const apiRoutes = new Hono<AppContext>()
  .route('/stores', storesRoutes)
  .route('/products', productItemRoutes)

// api.ts
const apiRoutes = new Hono<AppContext>()
  .route('/stores', storesRoutes)
  .route('/products', productItemRoutes)

// stores.ts
const storesRoutes = new Hono<AppContext>()
  // --- authenticated ---
  .use(requireAuth, requireActiveOrg, requireActiveStore)
  .get('/:storeId', async (c) => {
      // ...
    })
  .route('/:storeId/products', productsCollectionRoutes);

// stores.ts
const storesRoutes = new Hono<AppContext>()
  // --- authenticated ---
  .use(requireAuth, requireActiveOrg, requireActiveStore)
  .get('/:storeId', async (c) => {
      // ...
    })
  .route('/:storeId/products', productsCollectionRoutes);

// products.ts
// assume its running in the context of a store
export const productsCollectionRoutes = new Hono<OrgStoreActiveContext>()
  .get('/', zValidator('query', productsFiltersSchema), async     (c) => {
    // ...
  })
  .post('/', zValidator('query', productInsertSchema), async     (c) => {
    // ...
  })

export const productItemRoutes = new Hono<AppContext>()
  .use(requireAuth, requireActiveOrg, requireActiveStore)
  .get('/:productId', async (c) => {
    // ...
  })

// products.ts
// assume its running in the context of a store
export const productsCollectionRoutes = new Hono<OrgStoreActiveContext>()
  .get('/', zValidator('query', productsFiltersSchema), async     (c) => {
    // ...
  })
  .post('/', zValidator('query', productInsertSchema), async     (c) => {
    // ...
  })

export const productItemRoutes = new Hono<AppContext>()
  .use(requireAuth, requireActiveOrg, requireActiveStore)
  .get('/:productId', async (c) => {
    // ...
  })

Hono•4mo ago•

27 replies

Franco Romano Losada

RPC, nested routing and types

Hi everyone, quick question given the attached example:
- How do you avoid losing RPC typing when doing nested routing with different routes? Example

/api/stores/:storeId/products

/api/stores/:storeId/products

. The storeId is not required in RPC because

productsCollectionRoutes

productsCollectionRoutes

doesn't have the routing context of

storesRoutes

storesRoutes

.
- It would be less verbose to declare routes with :id instead of :productId, but I guess that's wouldn't work in RPC as I would have two

id

id

s?

As you can see, I have different routes like:
GET

/api/stores/:storeId

/api/stores/:storeId

--> get store
GET/POST

/api/stores/:storeId/products

/api/stores/:storeId/products

--> get or create products for a store
GET/PATCH/DELETE

/api/products/:productId

/api/products/:productId

--> get, update or delete a specific product

// api.ts
const apiRoutes = new Hono<AppContext>()
  .route('/stores', storesRoutes)
  .route('/products', productItemRoutes)

// api.ts
const apiRoutes = new Hono<AppContext>()
  .route('/stores', storesRoutes)
  .route('/products', productItemRoutes)

// stores.ts
const storesRoutes = new Hono<AppContext>()
  // --- authenticated ---
  .use(requireAuth, requireActiveOrg, requireActiveStore)
  .get('/:storeId', async (c) => {
      // ...
    })
  .route('/:storeId/products', productsCollectionRoutes);

// stores.ts
const storesRoutes = new Hono<AppContext>()
  // --- authenticated ---
  .use(requireAuth, requireActiveOrg, requireActiveStore)
  .get('/:storeId', async (c) => {
      // ...
    })
  .route('/:storeId/products', productsCollectionRoutes);

// products.ts
// assume its running in the context of a store
export const productsCollectionRoutes = new Hono<OrgStoreActiveContext>()
  .get('/', zValidator('query', productsFiltersSchema), async     (c) => {
    // ...
  })
  .post('/', zValidator('query', productInsertSchema), async     (c) => {
    // ...
  })

export const productItemRoutes = new Hono<AppContext>()
  .use(requireAuth, requireActiveOrg, requireActiveStore)
  .get('/:productId', async (c) => {
    // ...
  })

// products.ts
// assume its running in the context of a store
export const productsCollectionRoutes = new Hono<OrgStoreActiveContext>()
  .get('/', zValidator('query', productsFiltersSchema), async     (c) => {
    // ...
  })
  .post('/', zValidator('query', productInsertSchema), async     (c) => {
    // ...
  })

export const productItemRoutes = new Hono<AppContext>()
  .use(requireAuth, requireActiveOrg, requireActiveStore)
  .get('/:productId', async (c) => {
    // ...
  })

RPC, nested routing and types

Similar Threads

RPC, nested routing and types

Similar Threads

Similar Threads

Similar Threads