triad-endpoint

Endpoints and routers

endpoint() signature

import { endpoint, scenario, t } from '@triadjs/core';

export const createPet = endpoint({
  name: 'createPet',            // operationId in OpenAPI — must be unique
  method: 'POST',               // 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'
  path: '/pets',                // Express-style (/pets/:id)
  summary: 'Create a new pet',  // one-line human summary
  description: 'Longer prose.', // optional, flows into OpenAPI
  tags: ['Pets'],               // used to group operations in OpenAPI
  request: {
    body: CreatePet,
    params: { id: t.string() },
    query: { limit: t.int32().default(20) },
    // headers: { xRequestId: t.string().optional() },
  },
  beforeHandler: requireAuth,   // optional — see §Auth below
  responses: {
    201: { schema: Pet,      description: 'Created' },
    401: { schema: ApiError, description: 'Missing or invalid token' },
    409: { schema: ApiError, description: 'Duplicate' },
  },
  handler: async (ctx) => {
    const pet = await ctx.services.petRepo.create({
      ownerId: ctx.state.user.id,  // typed state from beforeHandler
      ...ctx.body,
    });
    return ctx.respond[201](pet);
  },
  behaviors: [ /* scenarios — see triad-behaviors skill */ ],
});

Return value is a normalized Endpoint — pass it to router.add(...).

HandlerContext — what ctx contains

Everything on ctx is inferred from the request and responses declarations: