@breadstone/archipel-mcp 0.0.15 → 0.0.16

package/data/packages/platform-core/api/TypeAlias.ProblemDetail.md

@@ -0,0 +1,28 @@
+---
+title: 'Type Alias: ProblemDetail'
+generated: true
+editUrl: false
+---
+# Type Alias: ProblemDetail
+
+```ts
+type ProblemDetail = {
+  detail: string;
+  instance?: string;
+  title: string;
+  type?: string;
+} & Record<string, string | number | string[] | number[]>;
+```
+
+Defined in: [filters/ProblemDetailExceptionFilter.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/ProblemDetailExceptionFilter.ts#L19)
+
+A Problem Detail object as per RFC 7807.
+
+## Type Declaration
+
+| Name | Type | Defined in |
+| ------ | ------ | ------ |
+| `detail` | `string` | [filters/ProblemDetailExceptionFilter.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/ProblemDetailExceptionFilter.ts#L22) |
+| `instance?` | `string` | [filters/ProblemDetailExceptionFilter.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/ProblemDetailExceptionFilter.ts#L23) |
+| `title` | `string` | [filters/ProblemDetailExceptionFilter.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/ProblemDetailExceptionFilter.ts#L21) |
+| `type?` | `string` | [filters/ProblemDetailExceptionFilter.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/ProblemDetailExceptionFilter.ts#L20) |

package/data/packages/platform-core/api/TypeAlias.ProblemDetailTypeUrlResolver.md

@@ -0,0 +1,25 @@
+---
+title: 'Type Alias: ProblemDetailTypeUrlResolver'
+generated: true
+editUrl: false
+---
+# Type Alias: ProblemDetailTypeUrlResolver
+
+```ts
+type ProblemDetailTypeUrlResolver = (code, title) => string;
+```
+
+Defined in: [filters/ProblemDetailExceptionFilter.ts:191](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/ProblemDetailExceptionFilter.ts#L191)
+
+A function that resolves a type URL for a given HTTP status code and title.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `code` | `number` |
+| `title` | `string` |
+
+## Returns
+
+`string`

package/data/packages/platform-core/api/TypeAlias.SetOptional.md

@@ -0,0 +1,21 @@
+---
+title: 'Type Alias: SetOptional\<T, K\>'
+generated: true
+editUrl: false
+---
+# Type Alias: SetOptional\<T, K\>
+
+```ts
+type SetOptional<T, K> = Omit<T, K> & Partial<Pick<T, K>>;
+```
+
+Defined in: [types/SetOptional.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/types/SetOptional.ts#L7)
+
+Sets the specified keys of T as optional.
+
+## Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | Original type |
+| `K` *extends* keyof `T` | Keys to set as optional |

package/data/packages/platform-core/api/TypeAlias.StringValue.md

@@ -0,0 +1,15 @@
+---
+title: 'Type Alias: StringValue'
+generated: true
+editUrl: false
+---
+# Type Alias: StringValue
+
+```ts
+type StringValue = 
+  | `${number}`
+  | `${number}${UnitAnyCase}`
+  | `${number} ${UnitAnyCase}`;
+```
+
+Defined in: [utils/DateTimeUtils.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/DateTimeUtils.ts#L13)

package/data/packages/platform-core/api/Variable.APP_NAME.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: APP\_NAME'
+generated: true
+editUrl: false
+---
+# Variable: APP\_NAME
+
+```ts
+const APP_NAME: IConfigKey<string>;
+```
+
+Defined in: [env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L22)
+
+Human-readable name of the application.

package/data/packages/platform-core/api/Variable.APP_PORT.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: APP\_PORT'
+generated: true
+editUrl: false
+---
+# Variable: APP\_PORT
+
+```ts
+const APP_PORT: IConfigKey<number>;
+```
+
+Defined in: [env.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L16)
+
+HTTP port the application listens on.

package/data/packages/platform-core/api/Variable.APP_URL.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: APP\_URL'
+generated: true
+editUrl: false
+---
+# Variable: APP\_URL
+
+```ts
+const APP_URL: IConfigKey<string>;
+```
+
+Defined in: [env.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L13)
+
+Base URL the application is served from (e.g. `https://example.com`).

package/data/packages/platform-core/api/Variable.APP_VERSION.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: APP\_VERSION'
+generated: true
+editUrl: false
+---
+# Variable: APP\_VERSION
+
+```ts
+const APP_VERSION: IConfigKey<string>;
+```
+
+Defined in: [env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L19)
+
+Semantic version of the running application (e.g. `1.2.3`).

package/data/packages/platform-core/api/Variable.GIT_COMMIT.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: GIT\_COMMIT'
+generated: true
+editUrl: false
+---
+# Variable: GIT\_COMMIT
+
+```ts
+const GIT_COMMIT: IConfigKey<string>;
+```
+
+Defined in: [env.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L28)
+
+Git commit SHA of the current build.

package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: HEALTH\_INDICATORS\_TOKEN'
+generated: true
+editUrl: false
+---
+# Variable: HEALTH\_INDICATORS\_TOKEN
+
+```ts
+const HEALTH_INDICATORS_TOKEN: typeof HEALTH_INDICATORS_TOKEN;
+```
+
+Defined in: [health/HealthTokens.ts:2](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/HealthTokens.ts#L2)
+
+Injection token for registered health indicators

package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: ID\_GENERATOR\_TOKEN'
+generated: true
+editUrl: false
+---
+# Variable: ID\_GENERATOR\_TOKEN
+
+```ts
+const ID_GENERATOR_TOKEN: typeof ID_GENERATOR_TOKEN;
+```
+
+Defined in: [identifiers/IdentifierTokens.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/IdentifierTokens.ts#L6)
+
+Interface for ID generators

package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md

@@ -0,0 +1,12 @@
+---
+title: 'Variable: IS\_PUBLIC\_KEY'
+generated: true
+editUrl: false
+---
+# Variable: IS\_PUBLIC\_KEY
+
+```ts
+const IS_PUBLIC_KEY: "isPublic" = 'isPublic';
+```
+
+Defined in: [decorators/Public.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/decorators/Public.ts#L7)

package/data/packages/platform-core/api/Variable.IpAddress.md

@@ -0,0 +1,31 @@
+---
+title: 'Variable: IpAddress'
+generated: true
+editUrl: false
+---
+# Variable: IpAddress
+
+```ts
+const IpAddress: (...dataOrPipes) => ParameterDecorator;
+```
+
+Defined in: [decorators/IpAddress.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/decorators/IpAddress.ts#L15)
+
+Extracts the client IP address from the current HTTP request.
+Handles IPv6 (::1), proxy headers (X-Forwarded-For), and normalizes the output.
+
+Examples:
+  "192.168.0.5"              -> "192.168.0.5"
+  "::ffff:127.0.0.1"         -> "127.0.0.1"
+  "::1" / "127.0.0.1"        -> "localhost"
+  undefined / ""             -> undefined
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| ...`dataOrPipes` | ( \| `string` \| `PipeTransform`\<`any`, `any`\> \| `Type`\<`PipeTransform`\<`any`, `any`\>\> \| `undefined`)[] |
+
+## Returns
+
+`ParameterDecorator`

package/data/packages/platform-core/api/Variable.Lang.md

@@ -0,0 +1,29 @@
+---
+title: 'Variable: Lang'
+generated: true
+editUrl: false
+---
+# Variable: Lang
+
+```ts
+const Lang: (...dataOrPipes) => ParameterDecorator;
+```
+
+Defined in: [decorators/Lang.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/decorators/Lang.ts#L13)
+
+Extracts the first language token from the Accept-Language header.
+
+Examples:
+  "da, en-gb;q=0.8, en;q=0.7" -> "da"
+  "en-US,en;q=0.9"            -> "en-US"
+  undefined / ""              -> undefined
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| ...`dataOrPipes` | ( \| `string` \| `PipeTransform`\<`any`, `any`\> \| `Type`\<`PipeTransform`\<`any`, `any`\>\> \| `undefined`)[] |
+
+## Returns
+
+`ParameterDecorator`

package/data/packages/platform-core/api/Variable.NODE_ENV.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: NODE\_ENV'
+generated: true
+editUrl: false
+---
+# Variable: NODE\_ENV
+
+```ts
+const NODE_ENV: IConfigKey<string>;
+```
+
+Defined in: [env.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L25)
+
+The current Node.js environment (`development`, `production`, etc.).

package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: PLATFORM\_CORE\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+# Variable: PLATFORM\_CORE\_CONFIG\_ENTRIES
+
+```ts
+const PLATFORM_CORE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
+```
+
+Defined in: [env.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L35)
+
+All configuration entries required by `platform-core`.

package/data/packages/platform-core/api/Variable.UserAgent.md

@@ -0,0 +1,24 @@
+---
+title: 'Variable: UserAgent'
+generated: true
+editUrl: false
+---
+# Variable: UserAgent
+
+```ts
+const UserAgent: (...dataOrPipes) => ParameterDecorator;
+```
+
+Defined in: [decorators/UserAgent.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/decorators/UserAgent.ts#L8)
+
+Extracts the User-Agent header from the incoming HTTP request.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| ...`dataOrPipes` | `unknown`[] |
+
+## Returns
+
+`ParameterDecorator`

package/data/packages/platform-core/api/index.md

@@ -0,0 +1,127 @@
+---
+title: '@breadstone/archipel-platform-core'
+generated: true
+editUrl: false
+---
+# @breadstone/archipel-platform-core
+
+## Namespaces
+
+| Namespace | Description |
+| ------ | ------ |
+| [ISseEventData](Namespace.ISseEventData) | Represents the data of a Server-Sent Event. |
+
+## Classes
+
+| Class | Description |
+| ------ | ------ |
+| [AppHealthIndicator](Class.AppHealthIndicator) | Health indicator for the application. |
+| [BlobResourceStrategy](Class.BlobResourceStrategy) | Strategy for loading resources from blob storage. |
+| [BooleanUtils](Class.BooleanUtils) | Boolean Utility Class. This class provides static methods to parse and format boolean values. |
+| [CasingInterceptor](Class.CasingInterceptor) | Global NestJS interceptor that normalizes property casing across the HTTP boundary. |
+| [CatchUtils](Class.CatchUtils) | - |
+| [ContentTemplateEngine](Class.ContentTemplateEngine) | The `ContentTemplateEngine` class. |
+| [CUIDGenerator](Class.CUIDGenerator) | CUID Generator class |
+| [DateTimeUtils](Class.DateTimeUtils) | TimeSpan Utility Class. Provides methods to parse and format time span values. |
+| [DeviceParserService](Class.DeviceParserService) | The `DeviceParserService` class. |
+| [EmbeddedResourceStrategy](Class.EmbeddedResourceStrategy) | Strategy for loading embedded resources from memory. |
+| [ErrorTemplateService](Class.ErrorTemplateService) | Service for rendering error page templates. |
+| [EventHub](Class.EventHub) | Provides a strongly typed event hub that can publish and subscribe to events. |
+| [EventModule](Class.EventModule) | Module that provides event hub services. |
+| [FileResourceStrategy](Class.FileResourceStrategy) | Strategy for loading resources from the local file system. |
+| [GlobalExceptionFilter](Class.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](Class.GUIDGenerator) | GUID Generator class |
+| [HealthModule](Class.HealthModule) | - |
+| [HealthOrchestrator](Class.HealthOrchestrator) | Orchestrates execution of all registered health indicators and aggregates their results. |
+| [HostModule](Class.HostModule) | The `HostModule` provides host-related services globally. |
+| [HostService](Class.HostService) | The `HostService` class. |
+| [HttpLoggerMiddleware](Class.HttpLoggerMiddleware) | - |
+| [IdentifierModule](Class.IdentifierModule) | - |
+| [IdGeneratorBase](Class.IdGeneratorBase) | Abstract base class for ID Generators |
+| [LimitRequestSizeMiddleware](Class.LimitRequestSizeMiddleware) | - |
+| [LocalizedTextRequest](Class.LocalizedTextRequest) | Request DTO for a single localized text entry. |
+| [LocalizedTextResponse](Class.LocalizedTextResponse) | Base class for localized text responses. |
+| [MappingBuilder](Class.MappingBuilder) | A mapping builder that uses the mapping service to register maps. |
+| [MappingModule](Class.MappingModule) | Module that provides mapping services and allows registration of mapping profiles. |
+| [MappingNotRegisteredError](Class.MappingNotRegisteredError) | Thrown when a keyed mapping is requested but not registered. |
+| [MappingProfileBase](Class.MappingProfileBase) | Base class for mapping profiles to simplify implementation. |
+| [MappingService](Class.MappingService) | Central mapping registry supporting keyed & type-based mappings. |
+| [NormalizedUtils](Class.NormalizedUtils) | Utility functions for normalizing data. |
+| [PageableRequest](Class.PageableRequest) | Base class describing pagination query parameters shared across endpoints. |
+| [PageableResponse](Class.PageableResponse) | Base class describing pagination metadata returned alongside list payloads. |
+| [ProblemDetailException](Class.ProblemDetailException) | A NestJS HttpException that represents a Problem Detail as per RFC 7807. |
+| [ProblemDetailExceptionFilter](Class.ProblemDetailExceptionFilter) | A NestJS exception filter that transforms exceptions into Problem Details compliant responses as per RFC 7807. |
+| [QuantityResponse](Class.QuantityResponse) | Base class for quantity responses. |
+| [ResourceManager](Class.ResourceManager) | Central manager for loading resources from various sources. Supports multiple strategies (file, blob, embedded) with caching. |
+| [ResourceModule](Class.ResourceModule) | Module providing the ResourceManager. |
+| [ResponseReturn](Class.ResponseReturn) | - |
+| [SseHub](Class.SseHub) | Represents a server-sent event service. |
+| [SseModule](Class.SseModule) | Represents the `SseModule` class. |
+| [TimeStampResponse](Class.TimeStampResponse) | The base class for all time stamp responses. |
+| [TypeMappingNotRegisteredError](Class.TypeMappingNotRegisteredError) | Thrown when a type mapping is requested but not registered. |
+| [UserAvatarGeneratorService](Class.UserAvatarGeneratorService) | Service for generating GitHub-style identicon avatars. |
+| [UserNameGeneratorService](Class.UserNameGeneratorService) | Random user name generator class |
+| [UUIDGenerator](Class.UUIDGenerator) | UUID Generator class |
+
+## Interfaces
+
+| Interface | Description |
+| ------ | ------ |
+| [IBlobResourceStrategyConfig](Interface.IBlobResourceStrategyConfig) | Configuration for the blob resource strategy. |
+| [IBlobServiceAdapter](Interface.IBlobServiceAdapter) | Minimal blob service interface to avoid circular dependencies. |
+| [IDeviceInfo](Interface.IDeviceInfo) | Interface for parsed device information |
+| [IErrorPageParams](Interface.IErrorPageParams) | Parameters for generating error page content. |
+| [IEventKey](Interface.IEventKey) | Represents a strongly typed event key that encodes the payload type. |
+| [IEventMap](Interface.IEventMap) | Represents the shape of the event map used by the [EventHub](Class.EventHub). |
+| [IFileResourceStrategyConfig](Interface.IFileResourceStrategyConfig) | Configuration for the file resource strategy. |
+| [IHealthCheckResult](Interface.IHealthCheckResult) | Represents the result of a health check indicator. |
+| [IHealthIndicator](Interface.IHealthIndicator) | Defines the contract for a health indicator that can be orchestrated. |
+| [IHostContentParams](Interface.IHostContentParams) | Parameters for generating host content. |
+| [IIdGenerator](Interface.IIdGenerator) | Interface for ID generators |
+| [IMappingBuilder](Interface.IMappingBuilder) | Defines the interface for a mapping builder. |
+| [IMappingKey](Interface.IMappingKey) | Type-safe mapping key that encodes both input and output types. This ensures compile-time type safety when using the mapping service. |
+| [IMappingProfile](Interface.IMappingProfile) | Defines the interface for a mapping profile. |
+| [IResourceManagerConfig](Interface.IResourceManagerConfig) | Configuration for the ResourceManager. |
+| [IResourceMetadata](Interface.IResourceMetadata) | Metadata about a resource. |
+| [IResourceResult](Interface.IResourceResult) | Result of loading a resource. |
+| [IResourceStrategy](Interface.IResourceStrategy) | Strategy for loading resources from a specific source. |
+| [ISseEventData](Interface.ISseEventData) | Represents the data of a Server-Sent Event. |
+| [ISseHub](Interface.ISseHub) | Represents a server-sent event service. |
+
+## Type Aliases
+
+| Type Alias | Description |
+| ------ | ------ |
+| [CamelCase](TypeAlias.CamelCase) | - |
+| [ProblemDetail](TypeAlias.ProblemDetail) | A Problem Detail object as per RFC 7807. |
+| [ProblemDetailTypeUrlResolver](TypeAlias.ProblemDetailTypeUrlResolver) | A function that resolves a type URL for a given HTTP status code and title. |
+| [SetOptional](TypeAlias.SetOptional) | Sets the specified keys of T as optional. |
+| [StringValue](TypeAlias.StringValue) | - |
+
+## Variables
+
+| Variable | Description |
+| ------ | ------ |
+| [APP\_NAME](Variable.APP_NAME) | Human-readable name of the application. |
+| [APP\_PORT](Variable.APP_PORT) | HTTP port the application listens on. |
+| [APP\_URL](Variable.APP_URL) | Base URL the application is served from (e.g. `https://example.com`). |
+| [APP\_VERSION](Variable.APP_VERSION) | Semantic version of the running application (e.g. `1.2.3`). |
+| [GIT\_COMMIT](Variable.GIT_COMMIT) | Git commit SHA of the current build. |
+| [HEALTH\_INDICATORS\_TOKEN](Variable.HEALTH_INDICATORS_TOKEN) | Injection token for registered health indicators |
+| [ID\_GENERATOR\_TOKEN](Variable.ID_GENERATOR_TOKEN) | Interface for ID generators |
+| [IpAddress](Variable.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](Variable.IS_PUBLIC_KEY) | - |
+| [Lang](Variable.Lang) | Extracts the first language token from the Accept-Language header. |
+| [NODE\_ENV](Variable.NODE_ENV) | The current Node.js environment (`development`, `production`, etc.). |
+| [PLATFORM\_CORE\_CONFIG\_ENTRIES](Variable.PLATFORM_CORE_CONFIG_ENTRIES) | All configuration entries required by `platform-core`. |
+| [UserAgent](Variable.UserAgent) | Extracts the User-Agent header from the incoming HTTP request. |
+
+## Functions
+
+| Function | Description |
+| ------ | ------ |
+| [createEventKey](Function.createEventKey) | Creates a branded event key for the [EventHub](Class.EventHub). |
+| [createMappingKey](Function.createMappingKey) | Creates a type-safe mapping key. |
+| [env](Function.env) | Marker function for environment strings. |
+| [getMimeTypeByFileNameOrExtension](Function.getMimeTypeByFileNameOrExtension) | Get MIME type by file name or extension. |
+| [Public](Function.Public) | The `Public` decorator. |