@breadstone/archipel-mcp 0.0.1

package/data/packages/platform-core/api/Interface.IConfigModuleOptions.md

@@ -0,0 +1,41 @@
+---
+title: 'Interface: IConfigModuleOptions'
+generated: true
+editUrl: false
+---
+
+# Interface: IConfigModuleOptions
+
+Defined in: [config/ConfigModule.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigModule.ts#L15)
+
+The `IConfigModuleOptions` interface.
+
+## Properties
+
+### statics?
+
+```ts
+optional statics?: Record<string, string>;
+```
+
+Defined in: [config/ConfigModule.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigModule.ts#L17)
+
+---
+
+### strategyFactory?
+
+```ts
+optional strategyFactory?: (...args) => ConfigStrategyBase;
+```
+
+Defined in: [config/ConfigModule.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigModule.ts#L16)
+
+#### Parameters
+
+| Parameter | Type    |
+| --------- | ------- |
+| ...`args` | `any`[] |
+
+#### Returns
+
+[`ConfigStrategyBase`](Class.ConfigStrategyBase)

package/data/packages/platform-core/api/Interface.IConfigRegistryEntry.md

@@ -0,0 +1,80 @@
+---
+title: 'Interface: IConfigRegistryEntry\<TType\>'
+generated: true
+editUrl: false
+---
+
+# Interface: IConfigRegistryEntry\<TType\>
+
+Defined in: [config/ConfigRegistry.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigRegistry.ts#L13)
+
+Describes a registered configuration entry, including its source module and
+whether the entry is required or optional (with a default value).
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| -------------- | ------------ |
+| `TType`        | `unknown`    |
+
+## Properties
+
+### defaultValue?
+
+```ts
+readonly optional defaultValue?: TType;
+```
+
+Defined in: [config/ConfigRegistry.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigRegistry.ts#L34)
+
+An optional default value used when the key is not set.
+Only meaningful when `required` is `false`.
+
+---
+
+### description?
+
+```ts
+readonly optional description?: string;
+```
+
+Defined in: [config/ConfigRegistry.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigRegistry.ts#L39)
+
+An optional human-readable description of the configuration entry.
+
+---
+
+### key
+
+```ts
+readonly key: IConfigKey<TType>;
+```
+
+Defined in: [config/ConfigRegistry.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigRegistry.ts#L17)
+
+The typed configuration key.
+
+---
+
+### module
+
+```ts
+readonly module: string;
+```
+
+Defined in: [config/ConfigRegistry.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigRegistry.ts#L22)
+
+The name of the module that registered this key (e.g. `'platform-authentication'`).
+
+---
+
+### required
+
+```ts
+readonly required: boolean;
+```
+
+Defined in: [config/ConfigRegistry.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigRegistry.ts#L28)
+
+Whether the configuration value is required at startup.
+If `true`, the application should fail fast when the value is missing.

package/data/packages/platform-core/api/Interface.IDeviceInfo.md

@@ -0,0 +1,81 @@
+---
+title: 'Interface: IDeviceInfo'
+generated: true
+editUrl: false
+---
+
+# Interface: IDeviceInfo
+
+Defined in: [services/DeviceParserService.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L13)
+
+Interface for parsed device information
+
+## Properties
+
+### browserName
+
+```ts
+browserName: string;
+```
+
+Defined in: [services/DeviceParserService.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L17)
+
+---
+
+### browserVersion
+
+```ts
+browserVersion: string | null;
+```
+
+Defined in: [services/DeviceParserService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L18)
+
+---
+
+### deviceName
+
+```ts
+deviceName: string;
+```
+
+Defined in: [services/DeviceParserService.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L16)
+
+---
+
+### deviceType
+
+```ts
+deviceType: string;
+```
+
+Defined in: [services/DeviceParserService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L15)
+
+---
+
+### osName
+
+```ts
+osName: string;
+```
+
+Defined in: [services/DeviceParserService.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L19)
+
+---
+
+### osVersion
+
+```ts
+osVersion: string | null;
+```
+
+Defined in: [services/DeviceParserService.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L20)
+
+---
+
+### userAgent
+
+```ts
+userAgent: string;
+```
+
+Defined in: [services/DeviceParserService.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L14)

package/data/packages/platform-core/api/Interface.IErrorPageParams.md

@@ -0,0 +1,154 @@
+---
+title: 'Interface: IErrorPageParams'
+generated: true
+editUrl: false
+---
+
+# Interface: IErrorPageParams
+
+Defined in: [services/ErrorTemplateService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L18)
+
+Parameters for generating error page content.
+
+## Properties
+
+### actionText?
+
+```ts
+optional actionText?: string;
+```
+
+Defined in: [services/ErrorTemplateService.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L49)
+
+Optional action button text.
+
+#### Default
+
+```ts
+'Go to Home';
+```
+
+---
+
+### footer?
+
+```ts
+optional footer?: {
+  copyright: string;
+};
+```
+
+Defined in: [services/ErrorTemplateService.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L68)
+
+Optional footer configuration.
+
+#### copyright
+
+```ts
+copyright: string;
+```
+
+---
+
+### message
+
+```ts
+message: string;
+```
+
+Defined in: [services/ErrorTemplateService.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L33)
+
+The error message.
+
+---
+
+### path
+
+```ts
+path: string;
+```
+
+Defined in: [services/ErrorTemplateService.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L38)
+
+The request path.
+
+---
+
+### showDetails?
+
+```ts
+optional showDetails?: boolean;
+```
+
+Defined in: [services/ErrorTemplateService.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L55)
+
+Whether to show error details (path, timestamp).
+
+#### Default
+
+```ts
+false in production;
+```
+
+---
+
+### statusCode
+
+```ts
+statusCode: number;
+```
+
+Defined in: [services/ErrorTemplateService.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L23)
+
+The HTTP status code.
+
+---
+
+### style?
+
+```ts
+optional style?: {
+  primary: string;
+  secondary: string;
+};
+```
+
+Defined in: [services/ErrorTemplateService.ts:60](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L60)
+
+Optional style configuration.
+
+#### primary
+
+```ts
+primary: string;
+```
+
+#### secondary
+
+```ts
+secondary: string;
+```
+
+---
+
+### timestamp?
+
+```ts
+optional timestamp?: string;
+```
+
+Defined in: [services/ErrorTemplateService.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L43)
+
+Optional timestamp.
+
+---
+
+### title
+
+```ts
+title: string;
+```
+
+Defined in: [services/ErrorTemplateService.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L28)
+
+The error title.

package/data/packages/platform-core/api/Interface.IEventKey.md

@@ -0,0 +1,58 @@
+---
+title: 'Interface: IEventKey\<TEvents, TKey\>'
+generated: true
+editUrl: false
+---
+
+# Interface: IEventKey\<TEvents, TKey\>
+
+Defined in: [events/EventKey.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventKey.ts#L12)
+
+Represents a strongly typed event key that encodes the payload type.
+
+## Type Parameters
+
+| Type Parameter                                         |
+| ------------------------------------------------------ |
+| `TEvents` _extends_ [`IEventMap`](Interface.IEventMap) |
+| `TKey` _extends_ keyof `TEvents`                       |
+
+## Properties
+
+### \_brand
+
+```ts
+readonly _brand: "EventKey";
+```
+
+Defined in: [events/EventKey.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventKey.ts#L13)
+
+---
+
+### \_events
+
+```ts
+readonly _events: TEvents;
+```
+
+Defined in: [events/EventKey.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventKey.ts#L14)
+
+---
+
+### \_payload
+
+```ts
+readonly _payload: TEvents[TKey];
+```
+
+Defined in: [events/EventKey.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventKey.ts#L15)
+
+---
+
+### event
+
+```ts
+readonly event: TKey;
+```
+
+Defined in: [events/EventKey.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventKey.ts#L16)

package/data/packages/platform-core/api/Interface.IEventMap.md

@@ -0,0 +1,17 @@
+---
+title: 'Interface: IEventMap'
+generated: true
+editUrl: false
+---
+
+# Interface: IEventMap
+
+Defined in: [events/IEventMap.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/IEventMap.ts#L6)
+
+Represents the shape of the event map used by the [EventHub](Class.EventHub).
+
+## Indexable
+
+```ts
+[eventName: string]: unknown
+```

package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md

@@ -0,0 +1,73 @@
+---
+title: 'Interface: IFileResourceStrategyConfig'
+generated: true
+editUrl: false
+---
+
+# Interface: IFileResourceStrategyConfig
+
+Defined in: [resources/strategies/FileResourceStrategy.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/FileResourceStrategy.ts#L18)
+
+Configuration for the file resource strategy.
+
+## Properties
+
+### basePaths
+
+```ts
+basePaths: string[];
+```
+
+Defined in: [resources/strategies/FileResourceStrategy.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/FileResourceStrategy.ts#L24)
+
+Base paths to search for resources.
+Paths are tried in order until the resource is found.
+
+---
+
+### defaultEncoding?
+
+```ts
+optional defaultEncoding?:
+  | "ascii"
+  | "utf8"
+  | "utf-8"
+  | "utf16le"
+  | "ucs2"
+  | "ucs-2"
+  | "base64"
+  | "base64url"
+  | "latin1"
+  | "binary"
+  | "hex";
+```
+
+Defined in: [resources/strategies/FileResourceStrategy.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/FileResourceStrategy.ts#L30)
+
+Optional default encoding for text files.
+
+#### Default
+
+```ts
+'utf-8';
+```
+
+---
+
+### includeSubfolders?
+
+```ts
+optional includeSubfolders?: boolean;
+```
+
+Defined in: [resources/strategies/FileResourceStrategy.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/FileResourceStrategy.ts#L38)
+
+Enable recursive search in subdirectories.
+When enabled, the strategy will search for files in all subdirectories
+of the base paths using glob patterns.
+
+#### Default
+
+```ts
+false;
+```

package/data/packages/platform-core/api/Interface.IHealthCheckResult.md

@@ -0,0 +1,47 @@
+---
+title: 'Interface: IHealthCheckResult'
+generated: true
+editUrl: false
+---
+
+# Interface: IHealthCheckResult
+
+Defined in: [health/IHealthCheckResult.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/IHealthCheckResult.ts#L6)
+
+Represents the result of a health check indicator.
+
+## Properties
+
+### details?
+
+```ts
+optional details?: Record<string, unknown>;
+```
+
+Defined in: [health/IHealthCheckResult.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/IHealthCheckResult.ts#L21)
+
+Optional additional details about the health check.
+
+---
+
+### name
+
+```ts
+name: string;
+```
+
+Defined in: [health/IHealthCheckResult.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/IHealthCheckResult.ts#L11)
+
+The name of the health indicator (e.g., 'database', 'app').
+
+---
+
+### status
+
+```ts
+status: 'up' | 'down';
+```
+
+Defined in: [health/IHealthCheckResult.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/IHealthCheckResult.ts#L16)
+
+The status of the health indicator ('up', 'down').

package/data/packages/platform-core/api/Interface.IHealthIndicator.md

@@ -0,0 +1,42 @@
+---
+title: 'Interface: IHealthIndicator'
+generated: true
+editUrl: false
+---
+
+# Interface: IHealthIndicator
+
+Defined in: [health/IHealthIndicator.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/IHealthIndicator.ts#L12)
+
+Defines the contract for a health indicator that can be orchestrated.
+
+## Properties
+
+### key
+
+```ts
+readonly key: string;
+```
+
+Defined in: [health/IHealthIndicator.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/IHealthIndicator.ts#L15)
+
+Unique key identifying the indicator
+
+## Methods
+
+### check()
+
+```ts
+check():
+  | HealthIndicatorResult<string>
+| Promise<HealthIndicatorResult<string>>;
+```
+
+Defined in: [health/IHealthIndicator.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/IHealthIndicator.ts#L18)
+
+Performs the health check and returns a result keyed by the indicator key
+
+#### Returns
+
+\| `HealthIndicatorResult`\<`string`\>
+\| `Promise`\<`HealthIndicatorResult`\<`string`\>\>