@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

MethodPathAuthDescription
GET/bio/:slugGet bio page by slug (public)
GET/bio/analytics/summaryYesGet bio page analytics
POST/bio/eventsTrack bio page event (public)

Internals

Use-cases

Application operations. Each is a single-purpose class with one execute() method.

Use-caseSignature
GetBioAnalyticsUseCaseexecute(tenantId: string, dateFrom?: string, dateTo?: string): Promise<BioPageAnalytics>
GetBioPageUseCaseexecute(slug: string)
TrackBioEventUseCaseexecute(dto: TrackBioEventDto, userAgent?: string)

Entities

Sequelize models owned by this module.

BioPageEvent — table bio_page_events

FieldType
idstring
tenantIdstring
tenantTenant
typeBioPageEventType
itemIdstring | null
referrerstring | null
userAgentstring | null
createdAtDate

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.