@breadstone/archipel-platform-bootstrap

Classes

Class	Description
CompositionContext	Default implementation of the composition context.
CompositionModule	Minimal module providing configuration access for composition.
CompositionResolver	Abstract base class for composition-time feature resolution.
PlatformApplication	Entry point for composing an existing NestJS application with Archipel bootstrap steps.
PlatformApplicationBuilder	Fluent builder that composes NestJS bootstrap steps and executes them once.
PlatformBootstrapContext	Runtime context shared by platform bootstrap steps.
PlatformBootstrapError	Error raised when an Archipel platform bootstrap step fails.

Interfaces

Interface	Description
IApiStepOptions	Options for the generic Archipel API bootstrap step.
IApiValidationOptions	Validation options used by the generic Archipel API bootstrap step.
ICompositionContext	Pre-bootstrap context for stage-aware module composition.
ICreateCompositionContextOptions	Options for creating the composition context.
ICreateWithCompositionOptions	Options for creating a composed application.
IExpressServerStepOptions	Options for the Express-compatible server bootstrap step.
IOpenApiStepOptions	Options for the OpenAPI bootstrap step.
IPlatformApplicationOptions	Options for wrapping an existing NestJS application with Archipel platform bootstrap support.
IPlatformListenOptions	Options for resolving the HTTP listen port from typed configuration keys.
IPlatformTestApplication	In-memory application contract used by platform bootstrap tests.
IProviderDecision	Represents the result of a provider composition decision.
ISecurityStepOptions	Options for the generic security bootstrap step.
ISessionStepOptions	Options for the Express-compatible session bootstrap step.

Type Aliases

Type Alias	Description
CompositionImport	Represents a valid NestJS module import that can be used during composition.
PlatformBootstrapNext	Continues execution with the next platform bootstrap step.
PlatformBootstrapStep	A composable bootstrap step in the platform application pipeline.
PlatformContentSecurityPolicyMode	Named content-security-policy modes supported by platform-bootstrap/security.
PlatformCorsOptions	CORS options accepted by the security bootstrap step.
ProviderComposer	Function signature for a provider composer.
SecurityRateLimitOptions	Rate-limit options accepted by the security bootstrap step.

Variables

Variable	Description
APP_CORS_ORIGIN	Comma-separated list of allowed CORS origins.
APP_RATE_LIMIT_MAX_REQUESTS	Maximum requests accepted within the rate-limit window.
APP_RATE_LIMIT_WINDOW_MS	Rate-limit window in milliseconds.
AUTH_SESSION_MAX_AGE	Session cookie lifetime, for example 30d or 86400000.
AUTH_SESSION_SECRET	Secret used by Express-compatible session middleware.
AUTH_SESSION_SECURE	Whether session cookies should be marked secure.
PLATFORM_SECURITY_CONFIG_ENTRIES	Security step configuration entries provided by platform-bootstrap/security.
PLATFORM_SERVER_CONFIG_ENTRIES	Server bootstrap configuration entries provided by platform-bootstrap.
PLATFORM_SESSION_CONFIG_ENTRIES	Session step configuration entries provided by platform-bootstrap/session.
PORT	HTTP port exposed by serverless hosts such as Vercel.

Functions

Function	Description
createCompositionContext	Creates a temporary NestJS context for stage-aware module composition.
createPlatformTestApplication	Creates a lightweight in-memory NestJS application double for platform bootstrap tests.
useApi	Creates the generic Archipel API bootstrap step.
useExpressServer	Creates an Express-compatible server bootstrap step.
useOpenApi	Creates the Archipel OpenAPI multi-document bootstrap step.
useSecurity	Creates the generic security bootstrap step.
useSession	Creates an Express-compatible session bootstrap step.