EngineModule referenceshared

@withpotter/shared — module reference

A support module — it mounts no HTTP routes of its own but contributes the internal building blocks below. See the package internal architecture for how the layers fit together.

Internals

Ports

DI contracts other modules bind adapters to.

  • InviteCodePort — token INVITE_CODE_PORT
  • OrgBootstrapInput, OrgBootstrapResult, OrgBootstrapPort — token ORG_BOOTSTRAP_PORT
  • AuthGuardProxy — token AUTH_GUARD
  • MailerAttachment, MailerMessage, MailerResult, MailerPort — token MAILER_PORT
  • TemplateEnginePort — token TEMPLATE_ENGINE_PORT, TEMPLATE_DIRS
  • TenantDomainRecord, TenantDomainPort — token TENANT_DOMAIN_REPOSITORY

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.

settlementshipping