add-route

Add New Hono IPC Route

Generate a new route for Hono-based IPC with proper structure and Zod validation.

Arguments

• $1 (required): Route name in kebab-case (e.g., users, auth, event-logs)

Steps

1. Determine Route Location

Find the shared callable directory:

• Look for src/shared/callable/ directory
• If not found, check for alternative structures

2. Create Route File

Create src/shared/callable/{route-name}/index.ts:

import { zValidator } from '@hono/zod-validator';
import { Hono } from 'hono';
import { z } from 'zod';

import type { HonoEnv } from '@shared/callable';

const app = new Hono<HonoEnv>();

// Define Zod schemas for request validation
// Example: const CreateItemBody = z.object({ name: z.string(), value: z.number() });

// Define route handlers
export const routes = app
  // GET /{route-name}
  .get('/', (c) => {
    // Access services via c.var.services
    // Example: return c.var.services.{service}.list()
    return c.json({ message: 'List items' }, 200);
  })

  // GET /{route-name}/:id
  .get('/:id', (c) => {
    const id = c.req.param('id');
    // Example: return c.var.services.{service}.get(id)
    return c.json({ id, message: 'Get item' }, 200);
  })

  // POST /{route-name}
  // .post('/', zValidator('json', CreateItemBody), (c) => {
  //   const body = c.req.valid('json');
  //   // Example: return c.var.services.{service}.create(body)
  //   return c.json({ message: 'Created' }, 201);
  // })

  // PUT /{route-name}/:id
  // .put('/:id', zValidator('json', UpdateItemBody), (c) => {
  //   const id = c.req.param('id');
  //   const body = c.req.valid('json');
  //   // Example: return c.var.services.{service}.update(id, body)
  //   return c.json({ message: 'Updated' }, 200);
  // })

  // DELETE /{route-name}/:id
  // .delete('/:id', (c) => {
  //   const id = c.req.param('id');
  //   // Example: return c.var.services.{service}.delete(id)
  //   return c.json({ message: 'Deleted' }, 200);
  // });