`@withpotter/onboarding` — 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

Onboarding `/onboarding`

Method	Path	Auth	Description
`GET`	`/onboarding/:tenantId/progress`	Yes	Get onboarding progress for a tenant
`POST`	`/onboarding/:tenantId/dismiss`	Yes	Dismiss onboarding checklist
`POST`	`/onboarding/:tenantId/duplicate`	Yes	Duplicate a workspace (config only)
`POST`	`/onboarding/:tenantId/seed`	Yes	Seed sample content for tenant
`POST`	`/onboarding/provision`	Yes	Provision a new tenant with template
`PATCH`	`/onboarding/:tenantId/intents`	Yes	Update tenant intents
`PATCH`	`/onboarding/:tenantId/steps`	Yes	Update onboarding step status

Internals

Use-cases

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

Use-case	Signature
`DismissOnboardingUseCase`	`execute(tenantId: string): Promise<{ dismissed: boolean }>`
`DuplicateTenantUseCase`	`execute(input: DuplicateTenantInput): Promise<DuplicateTenantResult>`
`GetOnboardingProgressUseCase`	`execute(tenantId: string): Promise<OnboardingProgress \| null>`
`ProvisionTenantUseCase`	`execute(input: ProvisionTenantInput): Promise<ProvisionTenantResult>`
`SeedContentUseCase`	`execute(input: SeedContentInput): Promise<SeedContentResult>`
`UpdateOnboardingStepUseCase`	`execute(input: UpdateStepInput): Promise<UpdateStepResult>`
`UpdateTenantIntentsUseCase`	`execute(input: UpdateTenantIntentsInput): Promise<UpdateTenantIntentsResult>`

Entities

Sequelize models owned by this module.

`OnboardingChecklist` — table `onboarding_checklists`

Field	Type
`id`	`string`
`tenantId`	`string`
`templateId`	`string`
`stepDefinitions`	`OnboardingStepDefinition[]`
`stepProgress`	`OnboardingStepProgress[]`
`completionPercentage`	`number`
`completedAt`	`Date \| null`
`dismissed`	`boolean`
`createdAt`	`Date`
`updatedAt`	`Date`

Repositories

Data-access classes wrapping the entities.

`OnboardingRepository`

create · findByTenant · findByTenantOrFail · updateStepProgress · dismiss · reset

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.

membership order

@withpotter/onboarding — module reference