@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.
BooleanUtils	Boolean Utility Class. This class provides static methods to parse and format boolean values.
CasingInterceptor	Global NestJS interceptor that normalizes property casing across the HTTP boundary.
CatchUtils	-
ContentTemplateEngine	The ContentTemplateEngine class.
CUIDGenerator	CUID Generator class
DateTimeUtils	TimeSpan Utility Class. Provides methods to parse and format time span values.
DeviceParserService	The DeviceParserService 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.
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
HostModule	The HostModule provides host-related services globally.
HostService	The HostService class.
HttpLoggerMiddleware	-
IdentifierModule	-
IdGeneratorBase	Abstract base class for ID Generators
LimitRequestSizeMiddleware	-
LocalizedTextRequest	Request DTO for a single localized text entry.
LocalizedTextResponse	Base class for localized text responses.
NormalizedUtils	Utility functions for normalizing data.
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.
ProblemDetailResponse	OpenAPI schema class representing a Problem Detail response as per RFC 9457.
QuantityResponse	Base class for quantity responses.
ResponseReturn	-
SseHub	Represents a server-sent event service.
SseModule	Represents the SseModule class.
TimeStampResponse	The base class for all time stamp responses.
UserAvatarGeneratorService	Service for generating GitHub-style identicon avatars.
UserNameGeneratorService	Random user name generator class
UUIDGenerator	UUID Generator class

Interfaces

Interface	Description
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.
IHostContentParams	Parameters for generating host content.
IIdGenerator	Interface for ID generators
ISseEventData	Represents the data of a Server-Sent Event.
ISseHub	Represents a server-sent event service.

Type Aliases

Type Alias	Description
CamelCase	-
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_NAME	Human-readable name of the application.
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).
GIT_COMMIT	Git commit SHA of the current build.
ID_GENERATOR_TOKEN	Interface for ID generators
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.).
PLATFORM_CORE_CONFIG_ENTRIES	All configuration entries required by platform-core.
UserAgent	Extracts the User-Agent header from the incoming HTTP request.

Functions

Function	Description
createEventKey	Creates a branded event key for the EventHub.
env	Marker function for environment strings.
getMimeTypeByFileNameOrExtension	Get MIME type by file name or extension.
maskSensitive	Serializes a value to a JSON string with sensitive keys masked.
maskSensitiveFields	Recursively masks values of sensitive keys in a plain object for safe logging.
Public	The Public decorator.