@withpotter/bio-page-event — module reference
HTTP routes this module mounts, plus its internal use-cases, entities, and repositories. The exhaustive request/response contract is the engine’s OpenAPI document at /docs; the layered structure below follows the package internal architecture.
HTTP routes
Bio Pages /bio
| Method | Path | Auth | Description |
|---|---|---|---|
GET | /bio/:slug | — | Get bio page by slug (public) |
GET | /bio/analytics/summary | Yes | Get bio page analytics |
POST | /bio/events | — | Track bio page event (public) |
Internals
Use-cases
Application operations. Each is a single-purpose class with one execute() method.
| Use-case | Signature |
|---|---|
GetBioAnalyticsUseCase | execute(tenantId: string, dateFrom?: string, dateTo?: string): Promise<BioPageAnalytics> |
GetBioPageUseCase | execute(slug: string) |
TrackBioEventUseCase | execute(dto: TrackBioEventDto, userAgent?: string) |
Entities
Sequelize models owned by this module.
BioPageEvent — table bio_page_events
| Field | Type |
|---|---|
id | string |
tenantId | string |
tenant | Tenant |
type | BioPageEventType |
itemId | string | null |
referrer | string | null |
userAgent | string | null |
createdAt | Date |
Repositories
Data-access classes wrapping the entities.
BioPageEventRepository
create · getAnalytics
Generated from the module’s source. Routes are relative to the engine root
(default http://localhost:3001). For full request/response schemas use the live
OpenAPI document.