api

name	api
description	Defines the authored and generated parts of packages/api, its public entry, shared diagnosers, SDK connections, and simulation boundary. Read before editing or importing the API package.

API Package

Ownership

packages/api is the public contract. The backend implements it and the frontend consumes it.

Path	Ownership
src/structures/*.ts	Authored requirement-derived DTOs
src/typings/**	Authored transport primitives such as IEntity, IPage, and IDiagnosis
src/diagnosers/**	Authored pure rules shared by client and server
src/functional/**	Generated Nestia accessors

Never edit generated paths. Change controllers or DTOs, then run backend pnpm build:sdk.

src/index.ts is the only public entry. Export every authored DTO through src/structures/index.ts and then the package entry. Import from the package name:

import * as api from "@benchmark/shopping-api";

const page: api.IPage<api.IShoppingSale.ISummary> =
  await api.functional....(connection, {
    : { :  },
  });