TypeScript Reference

This site is generated by TypeDoc from the intentionally public TypeScript API of the foodtruck-order repository.

The project's own documentation is part of the documentation site:

• Markdown documentation (architecture, development, testing, CI, Docker): see the Project documentation pages.
• HTTP API contract and interactive Swagger UI: see the API documentation page.

What is documented here

Only the intentional public API boundaries are documented, one group per application area:

• Shared — the @foodtruck-order/db package entry point (packages/db/src/index.ts), the package's declared exports surface (schema and client).
• Backend — the backend's intentional public API: buildApp and the error contract (api-errors.ts), the application services (message-service.ts, user-service.ts, password-service.ts), the domain types (message.ts, user.ts), and the repository contracts (message-repository.ts, user-repository.ts).
• Frontend — the frontend's intentionally public API boundary, split into the same architectural areas the code itself uses:
  • the API/service boundary (app/api/), application state and platform modules (app/preferences/, app/i18n/, notifications, query client, router, pages, providers, theme, layout);
  • build/runtime diagnostics (build metadata, identity, diagnostics, error messages);
  • reusable presentation components (components/), and the composition root (App.tsx).

Implementation details — private helpers, local functions, test code, generated code, third-party type definitions, the backend's process bootstrap, its database-specific repository implementations, the backend's own configuration, the frontend's Vite bootstrap and individual page implementations — are intentionally excluded.

Documentation gate

Configured public symbols are checked for inline TSDoc comments (pnpm docs:check). Missing comments fail the gate; their meaning and completeness require human review. See docs/documentation.md for the definition of "public API" and the exact rules.