@breadstone/archipel-platform-core

Namespaces

Namespace	Description
ISseEventData	Represents the data of a Server-Sent Event.

Classes

Class	Description
AppHealthIndicator	Health indicator for the application.
BcryptService	The BcryptService class. Represents the service that provides bcrypt operations.
BlobResourceStrategy	Strategy for loading resources from blob storage.
BooleanUtils	Boolean Utility Class. This class provides static methods to parse and format boolean values.
CasingInterceptor	This interceptor is responsible for converting snake_case or other casing styles in the request body to camelCase before passing them to controllers. It also handles the transformation of the response if needed.
CatchUtils	-
ConfigModule	The ConfigModule class.
ConfigRegistry	A static, global registry that collects all configuration keys registered by platform libraries. This enables a central overview of every environment variable the application depends on, grouped by source module.
ConfigService	-
ConfigStrategyBase	The ConfigStrategyBase class. Represents the base class for configuration strategies.
ContentTemplateEngine	The ContentTemplateEngine class.
CryptoService	The CryptoService class. Represents the service that provides cryptographic operations.
CUIDGenerator	CUID Generator class
DateTimeUtils	TimeSpan Utility Class. Provides methods to parse and format time span values.
DeviceParserService	The DeviceParserService class.
EmbeddedResourceStrategy	Strategy for loading embedded resources from memory.
EnvironmentConfigStrategy	The EnvironmentConfigStrategy class.
ErrorTemplateService	Service for rendering error page templates.
EventHub	Provides a strongly typed event hub that can publish and subscribe to events.
EventModule	Module that provides event hub services.
FileConfigStrategy	The FileConfigStrategy class.
FileResourceStrategy	Strategy for loading resources from the local file system.
GlobalExceptionFilter	A global exception filter that handles all uncaught exceptions in the application. Returns HTML error pages for browser requests and JSON for API requests.
GUIDGenerator	GUID Generator class
HealthModule	-
HealthOrchestrator	Orchestrates execution of all registered health indicators and aggregates their results.
HostModule	The HostModule provides host-related services globally.
HostService	The HostService class.
HttpLoggerMiddleware	-
IdentifierModule	-
IdGeneratorBase	Abstract base class for ID Generators
IntelligenceCapabilityRegistrarBase	Provides a reusable registration flow that allows feature modules to contribute capabilities to the global intelligence registry while keeping their implementation details private.
IntelligenceCapabilityRegistry	Central registry responsible for resolving intelligence capabilities based on intent metadata.
IntelligenceModule	Core module exposing the shared intelligence infrastructure to feature modules.
IntelligenceTextGenerator	Executes text completions using the configured intelligence provider.
LimitRequestSizeMiddleware	-
LocalizedTextRequest	Request DTO for a single localized text entry.
LocalizedTextResponse	Base class for localized text responses.
MappingBuilder	A mapping builder that uses the mapping service to register maps.
MappingModule	Module that provides mapping services and allows registration of mapping profiles.
MappingNotRegisteredError	Thrown when a keyed mapping is requested but not registered.
MappingProfileBase	Base class for mapping profiles to simplify implementation.
MappingService	Central mapping registry supporting keyed & type-based mappings.
MemoryLayeredCache	In-memory layered cache implementation.
NoopCacheMetricsRecorder	No-op implementation used when no metrics backend is configured.
NormalizedUtils	Utility functions for normalizing data.
OtpService	OTP service implementation backed by otplib v13.
PageableRequest	Base class describing pagination query parameters shared across endpoints.
PageableResponse	Base class describing pagination metadata returned alongside list payloads.
ProblemDetailException	A NestJS HttpException that represents a Problem Detail as per RFC 7807.
ProblemDetailExceptionFilter	A NestJS exception filter that transforms exceptions into Problem Details compliant responses as per RFC 7807.
QuantityResponse	Base class for quantity responses.
RedisLayeredCache	Generic layered cache contract (DB first, then memory, then external fetcher).
ResourceManager	Central manager for loading resources from various sources. Supports multiple strategies (file, blob, embedded) with caching.
ResourceModule	Module providing the ResourceManager.
ResponseReturn	-
SseHub	Represents a server-sent event service.
SseModule	Represents the SseModule class.
TimeStampResponse	The base class for all time stamp responses.
TypeMappingNotRegisteredError	Thrown when a type mapping is requested but not registered.
UserAvatarGeneratorService	Service for generating GitHub-style identicon avatars.
UserNameGeneratorService	Random user name generator class
UUIDGenerator	UUID Generator class

Interfaces

Interface	Description
IBlobResourceStrategyConfig	Configuration for the blob resource strategy.
IBlobServiceAdapter	Minimal blob service interface to avoid circular dependencies.
ICacheMetricsRecorder	Metrics recorder for cache operations. Implementations can forward to Prometheus, OpenTelemetry, etc.
ICacheStats	Cache statistics.
IConfigKey	A type-safe config key that encodes both the config key and the type of its value.
IConfigModuleOptions	The IConfigModuleOptions interface.
IConfigRegistryEntry	Describes a registered configuration entry, including its source module and whether the entry is required or optional (with a default value).
IDeviceInfo	Interface for parsed device information
IErrorPageParams	Parameters for generating error page content.
IEventKey	Represents a strongly typed event key that encodes the payload type.
IEventMap	Represents the shape of the event map used by the EventHub.
IFileResourceStrategyConfig	Configuration for the file resource strategy.
IHealthCheckResult	Represents the result of a health check indicator.
IHealthIndicator	Defines the contract for a health indicator that can be orchestrated.
IHostContentParams	Parameters for generating host content.
IIdGenerator	Interface for ID generators
IIntelligenceArtifact	Represents a structured artifact returned by a capability.
IIntelligenceCapability	Abstraction implemented by all capability providers.
IIntelligenceCapabilityMetadata	Metadata describing a capability for orchestration and analytics purposes.
IIntelligenceCapabilityPayload	Payload forwarded to capabilities for execution.
IIntelligenceCapabilityRegistry	Registry abstraction responsible for resolving capabilities.
IIntelligenceCapabilityResult	Represents the outcome produced by a capability execution.
IIntelligenceCompletionUsage	Captures usage telemetry returned by the intelligence provider.
IIntelligenceContext	Describes the context aggregated before routing a request to a capability.
IIntelligenceContextBuilder	Responsible for composing the context supplied to capabilities.
IIntelligenceConversationMessageSnapshot	Represents a single message returned within a conversation snapshot.
IIntelligenceConversationSnapshot	Represents a lightweight snapshot of a conversation used for context building.
IIntelligenceFollowUpQuestion	Represents a follow-up question suggested to keep the dialogue active.
IIntelligenceIntent	Represents the structured intent resolved from a user message.
IIntelligenceIntentEntity	Represents an entity extracted from a resolved intelligence intent.
IIntelligenceMessageModel	Represents a normalized message stored in persistence.
IIntelligenceMessagePayload	Carries the payload submitted when messaging the intelligence entrypoint.
IIntelligencePrompt	Represents the input supplied to the intelligence text generator.
IIntelligencePromptMessage	Describes a normalized message used for text generation prompts.
IIntelligenceProviderConfiguration	Describes the resolved configuration for the intelligence provider.
IIntelligenceResponseMessage	Represents a single assistant message returned by a capability.
IIntelligenceTextCompletion	Represents the normalized completion result produced by the intelligence provider.
IIntelligenceTextGenerationOptions	Options that can be supplied when generating text with the intelligence provider.
IIntelligenceTextGenerator	Abstraction responsible for executing text completions using the configured provider.
ILayeredCache	Generic layered cache contract (DB first, then memory, then external fetcher).
ILayeredCacheOptions	In-memory layered cache: memory (LRU+TTL+SWR) + async loader fallback.
IMappingBuilder	Defines the interface for a mapping builder.
IMappingKey	Type-safe mapping key that encodes both input and output types. This ensures compile-time type safety when using the mapping service.
IMappingProfile	Defines the interface for a mapping profile.
IOtpService	Abstraction over OTP (One-Time Password) operations.
IOtpUriOptions	Options for generating an OTP authentication URI (otpauth://).
IRedisLayeredCacheOptions	Skeleton Redis-backed cache (placeholder; implement ioredis logic later). Provides same contract as in-memory layered cache; currently delegates to provided loader only.
IResourceManagerConfig	Configuration for the ResourceManager.
IResourceMetadata	Metadata about a resource.
IResourceResult	Result of loading a resource.
IResourceStrategy	Strategy for loading resources from a specific source.
ISseEventData	Represents the data of a Server-Sent Event.
ISseHub	Represents a server-sent event service.

Type Aliases

Type Alias	Description
CamelCase	-
IntelligenceConversationMessageRole	Represents the union of supported conversation message roles.
IntelligenceProviderName	Represents the union of supported intelligence provider identifiers.
ProblemDetail	A Problem Detail object as per RFC 7807.
ProblemDetailTypeUrlResolver	A function that resolves a type URL for a given HTTP status code and title.
SetOptional	Sets the specified keys of T as optional.
StringValue	-

Variables

Variable	Description
APP_PORT	HTTP port the application listens on.
APP_URL	Base URL the application is served from (e.g. https://example.com).
APP_VERSION	Semantic version of the running application (e.g. 1.2.3).
HEALTH_INDICATORS_TOKEN	Injection token for registered health indicators
ID_GENERATOR_TOKEN	Interface for ID generators
INTELLIGENCE_MAX_OUTPUT_TOKENS	Maximum number of output tokens for the AI model.
INTELLIGENCE_MODEL	AI model identifier to use for text generation.
INTELLIGENCE_TEMPERATURE	Sampling temperature for the AI model.
INTELLIGENCE_TOP_P	Top-p (nucleus sampling) for the AI model.
IntelligenceConversationMessageRoles	Enumerates the conversation roles used for contextual snapshots and messages.
IntelligenceProviderNames	Enumerates the supported model providers powering the intelligence pipeline.
IpAddress	Extracts the client IP address from the current HTTP request. Handles IPv6 (::1), proxy headers (X-Forwarded-For), and normalizes the output.
IS_PUBLIC_KEY	-
Lang	Extracts the first language token from the Accept-Language header.
NODE_ENV	The current Node.js environment (development, production, etc.).
OTP_SERVICE_TOKEN	Injection token for IOtpService.
PLATFORM_CORE_CONFIG_ENTRIES	All configuration entries required by platform-core.
TOTP_EPOCH_TOLERANCE	TOTP verification tolerance expressed in seconds (otplib v13 epochTolerance).
UserAgent	Extracts the User-Agent header from the incoming HTTP request.

Functions

Function	Description
createConfigKey	Creates a type-safe config key.
createEventKey	Creates a branded event key for the EventHub.
createMappingKey	Creates a type-safe mapping key.
env	Marker function for environment strings.
getMimeTypeByFileNameOrExtension	Get MIME type by file name or extension.
Public	The Public decorator.