@withpotter/feedback — 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
Feedback /feedback
| Method | Path | Auth | Description |
|---|---|---|---|
POST | /feedback | Yes | Submit feedback from the dashboard |
Internals
Use-cases
Application operations. Each is a single-purpose class with one execute() method.
| Use-case | Signature |
|---|---|
SubmitFeedbackUseCase | execute(accountId: string, dto: CreateFeedbackDto, debugMeta: FeedbackDebugMeta, tenantId?: string, tenantSlug?: string, userEmail?: string): Promise<FeedbackResponseDto> |
Entities
Sequelize models owned by this module.
Feedback — table feedback
| Field | Type |
|---|---|
id | string |
tenantId | string | null |
tenant | Tenant |
accountId | string |
category | FeedbackCategory |
description | string |
pageUrl | string |
browserInfo | FeedbackBrowserInfo |
debugMeta | FeedbackDebugMeta |
screenshotUrl | string | null |
githubIssueUrl | string | null |
githubIssueNumber | number | null |
status | FeedbackStatus |
createdAt | Date |
updatedAt | Date |
Repositories
Data-access classes wrapping the entities.
FeedbackRepository
create · update
Services
GitHubFeedbackService
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.