@breadstone/archipel-mcp 0.0.1

package/data/packages/platform-core/api/Class.FileConfigStrategy.md

@@ -0,0 +1,150 @@
+---
+title: 'Class: FileConfigStrategy'
+generated: true
+editUrl: false
+---
+
+# Class: FileConfigStrategy
+
+Defined in: [config/strategies/FileConfigStrategy.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/FileConfigStrategy.ts#L16)
+
+The `FileConfigStrategy` class.
+
+## Extends
+
+- [`ConfigStrategyBase`](Class.ConfigStrategyBase)
+
+## Constructors
+
+### Constructor
+
+```ts
+new FileConfigStrategy(envFile): FileConfigStrategy;
+```
+
+Defined in: [config/strategies/FileConfigStrategy.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/FileConfigStrategy.ts#L27)
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `envFile` | `string` |
+
+#### Returns
+
+`FileConfigStrategy`
+
+#### Overrides
+
+```ts
+ConfigStrategyBase.constructor;
+```
+
+## Methods
+
+### has()
+
+```ts
+has(key): boolean;
+```
+
+Defined in: [config/strategies/FileConfigStrategy.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/FileConfigStrategy.ts#L64)
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `key`     | `string` |
+
+#### Returns
+
+`boolean`
+
+#### Overrides
+
+[`ConfigStrategyBase`](Class.ConfigStrategyBase).[`has`](Class.ConfigStrategyBase#has)
+
+---
+
+### initialize()
+
+```ts
+initialize(): void;
+```
+
+Defined in: [config/strategies/FileConfigStrategy.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/FileConfigStrategy.ts#L37)
+
+`initialize` - Initializes the configuration.
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`ConfigStrategyBase`](Class.ConfigStrategyBase).[`initialize`](Class.ConfigStrategyBase#initialize)
+
+---
+
+### resolve()
+
+```ts
+resolve<T>(key): T;
+```
+
+Defined in: [config/strategies/FileConfigStrategy.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/FileConfigStrategy.ts#L43)
+
+`resolve` - Resolves the configuration.
+
+#### Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `T`            |
+
+#### Parameters
+
+| Parameter | Type     | Description         |
+| --------- | -------- | ------------------- |
+| `key`     | `string` | The key to resolve. |
+
+#### Returns
+
+`T`
+
+The resolved configuration value.
+
+#### Overrides
+
+[`ConfigStrategyBase`](Class.ConfigStrategyBase).[`resolve`](Class.ConfigStrategyBase#resolve)
+
+---
+
+### tryResolve()
+
+```ts
+tryResolve<T>(key, fallback): T;
+```
+
+Defined in: [config/strategies/FileConfigStrategy.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/FileConfigStrategy.ts#L53)
+
+#### Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `T`            |
+
+#### Parameters
+
+| Parameter  | Type     |
+| ---------- | -------- |
+| `key`      | `string` |
+| `fallback` | `T`      |
+
+#### Returns
+
+`T`
+
+#### Overrides
+
+[`ConfigStrategyBase`](Class.ConfigStrategyBase).[`tryResolve`](Class.ConfigStrategyBase#tryresolve)

package/data/packages/platform-core/api/Class.FileResourceStrategy.md

@@ -0,0 +1,193 @@
+---
+title: 'Class: FileResourceStrategy'
+generated: true
+editUrl: false
+---
+
+# Class: FileResourceStrategy
+
+Defined in: [resources/strategies/FileResourceStrategy.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/FileResourceStrategy.ts#L47)
+
+Strategy for loading resources from the local file system.
+
+## Implements
+
+- [`IResourceStrategy`](Interface.IResourceStrategy)
+
+## Constructors
+
+### Constructor
+
+```ts
+new FileResourceStrategy(config): FileResourceStrategy;
+```
+
+Defined in: [resources/strategies/FileResourceStrategy.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/FileResourceStrategy.ts#L63)
+
+Constructs a new instance of the `FileResourceStrategy` class.
+
+#### Parameters
+
+| Parameter | Type                                                                   |
+| --------- | ---------------------------------------------------------------------- |
+| `config`  | [`IFileResourceStrategyConfig`](Interface.IFileResourceStrategyConfig) |
+
+#### Returns
+
+`FileResourceStrategy`
+
+## Accessors
+
+### name
+
+#### Get Signature
+
+```ts
+get name(): string;
+```
+
+Defined in: [resources/strategies/FileResourceStrategy.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/FileResourceStrategy.ts#L75)
+
+The unique name of this strategy.
+
+##### Returns
+
+`string`
+
+The unique name of this strategy.
+
+#### Implementation of
+
+[`IResourceStrategy`](Interface.IResourceStrategy).[`name`](Interface.IResourceStrategy#name)
+
+## Methods
+
+### exists()
+
+```ts
+exists(key): boolean;
+```
+
+Defined in: [resources/strategies/FileResourceStrategy.ts:138](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/FileResourceStrategy.ts#L138)
+
+Checks if a resource exists without loading it.
+
+#### Parameters
+
+| Parameter | Type     | Description      |
+| --------- | -------- | ---------------- |
+| `key`     | `string` | The resource key |
+
+#### Returns
+
+`boolean`
+
+True if the resource exists
+
+#### Implementation of
+
+[`IResourceStrategy`](Interface.IResourceStrategy).[`exists`](Interface.IResourceStrategy#exists)
+
+---
+
+### existsAsync()
+
+```ts
+existsAsync(key): Promise<boolean>;
+```
+
+Defined in: [resources/strategies/FileResourceStrategy.ts:149](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/FileResourceStrategy.ts#L149)
+
+Checks if a resource exists without loading it (asynchronous).
+
+#### Parameters
+
+| Parameter | Type     | Description      |
+| --------- | -------- | ---------------- |
+| `key`     | `string` | The resource key |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+Promise resolving to true if the resource exists
+
+#### Implementation of
+
+[`IResourceStrategy`](Interface.IResourceStrategy).[`existsAsync`](Interface.IResourceStrategy#existsasync)
+
+---
+
+### load()
+
+```ts
+load(key): IResourceResult | undefined;
+```
+
+Defined in: [resources/strategies/FileResourceStrategy.ts:90](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/FileResourceStrategy.ts#L90)
+
+Loads a resource by its key.
+
+#### Parameters
+
+| Parameter | Type     | Description      |
+| --------- | -------- | ---------------- |
+| `key`     | `string` | The resource key |
+
+#### Returns
+
+[`IResourceResult`](Interface.IResourceResult) \| `undefined`
+
+The resource result or undefined if not found
+
+#### Implementation of
+
+[`IResourceStrategy`](Interface.IResourceStrategy).[`load`](Interface.IResourceStrategy#load)
+
+---
+
+### loadAsync()
+
+```ts
+loadAsync(key): Promise<IResourceResult | undefined>;
+```
+
+Defined in: [resources/strategies/FileResourceStrategy.ts:127](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/FileResourceStrategy.ts#L127)
+
+Loads a resource by its key (asynchronous).
+
+#### Parameters
+
+| Parameter | Type     | Description      |
+| --------- | -------- | ---------------- |
+| `key`     | `string` | The resource key |
+
+#### Returns
+
+`Promise`\<[`IResourceResult`](Interface.IResourceResult) \| `undefined`\>
+
+Promise resolving to the resource result or undefined if not found
+
+#### Implementation of
+
+[`IResourceStrategy`](Interface.IResourceStrategy).[`loadAsync`](Interface.IResourceStrategy#loadasync)
+
+---
+
+### whatDoIHave()
+
+```ts
+whatDoIHave(): void;
+```
+
+Defined in: [resources/strategies/FileResourceStrategy.ts:158](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/FileResourceStrategy.ts#L158)
+
+List all files and folders in the base paths for debugging purposes.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`IResourceStrategy`](Interface.IResourceStrategy).[`whatDoIHave`](Interface.IResourceStrategy#whatdoihave)

package/data/packages/platform-core/api/Class.GUIDGenerator.md

@@ -0,0 +1,86 @@
+---
+title: 'Class: GUIDGenerator'
+generated: true
+editUrl: false
+---
+
+# Class: GUIDGenerator
+
+Defined in: [identifiers/generators/GUIDGenerator.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/GUIDGenerator.ts#L14)
+
+GUID Generator class
+
+## Extends
+
+- [`IdGeneratorBase`](Class.IdGeneratorBase)
+
+## Constructors
+
+### Constructor
+
+```ts
+new GUIDGenerator(): GUIDGenerator;
+```
+
+#### Returns
+
+`GUIDGenerator`
+
+#### Inherited from
+
+[`IdGeneratorBase`](Class.IdGeneratorBase).[`constructor`](Class.IdGeneratorBase#constructor)
+
+## Methods
+
+### generate()
+
+```ts
+generate(prefix?, postfix?): string;
+```
+
+Defined in: [identifiers/generators/GUIDGenerator.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/GUIDGenerator.ts#L23)
+
+Generates a GUID (variant of UUID)
+
+#### Parameters
+
+| Parameter  | Type     | Description                          |
+| ---------- | -------- | ------------------------------------ |
+| `prefix?`  | `string` | Optional prefix to prepend to the ID |
+| `postfix?` | `string` | Optional postfix to append to the ID |
+
+#### Returns
+
+`string`
+
+#### Overrides
+
+[`IdGeneratorBase`](Class.IdGeneratorBase).[`generate`](Class.IdGeneratorBase#generate)
+
+---
+
+### isValid()
+
+```ts
+isValid(id): boolean;
+```
+
+Defined in: [identifiers/generators/GUIDGenerator.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/GUIDGenerator.ts#L39)
+
+Validates if the provided string is a valid GUID
+
+#### Parameters
+
+| Parameter | Type     | Description        |
+| --------- | -------- | ------------------ |
+| `id`      | `string` | The ID to validate |
+
+#### Returns
+
+`boolean`
+
+True if the ID is valid, otherwise false
+
+#### Overrides
+
+[`IdGeneratorBase`](Class.IdGeneratorBase).[`isValid`](Class.IdGeneratorBase#isvalid)

package/data/packages/platform-core/api/Class.GlobalExceptionFilter.md

@@ -0,0 +1,67 @@
+---
+title: 'Class: GlobalExceptionFilter'
+generated: true
+editUrl: false
+---
+
+# Class: GlobalExceptionFilter
+
+Defined in: [filters/GlobalExceptionFilter.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/GlobalExceptionFilter.ts#L17)
+
+A global exception filter that handles all uncaught exceptions in the application.
+Returns HTML error pages for browser requests and JSON for API requests.
+
+## Implements
+
+- `ExceptionFilter`
+
+## Constructors
+
+### Constructor
+
+```ts
+new GlobalExceptionFilter(errorTemplateService?): GlobalExceptionFilter;
+```
+
+Defined in: [filters/GlobalExceptionFilter.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/GlobalExceptionFilter.ts#L33)
+
+Constructs a new instance of the `GlobalExceptionFilter` class.
+
+#### Parameters
+
+| Parameter               | Type                                                 | Description                                         |
+| ----------------------- | ---------------------------------------------------- | --------------------------------------------------- |
+| `errorTemplateService?` | [`ErrorTemplateService`](Class.ErrorTemplateService) | Optional error template service for HTML rendering. |
+
+#### Returns
+
+`GlobalExceptionFilter`
+
+## Methods
+
+### catch()
+
+```ts
+catch(exception, host): Promise<void>;
+```
+
+Defined in: [filters/GlobalExceptionFilter.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/GlobalExceptionFilter.ts#L50)
+
+Catches the exception and formats the response.
+
+#### Parameters
+
+| Parameter   | Type            | Description           |
+| ----------- | --------------- | --------------------- |
+| `exception` | `unknown`       | The caught exception. |
+| `host`      | `ArgumentsHost` | The arguments host.   |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+```ts
+ExceptionFilter.catch;
+```

package/data/packages/platform-core/api/Class.HealthModule.md

@@ -0,0 +1,43 @@
+---
+title: 'Class: HealthModule'
+generated: true
+editUrl: false
+---
+
+# Class: HealthModule
+
+Defined in: [health/HealthModule.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/HealthModule.ts#L21)
+
+## Constructors
+
+### Constructor
+
+```ts
+new HealthModule(): HealthModule;
+```
+
+#### Returns
+
+`HealthModule`
+
+## Methods
+
+### withIndicators()
+
+```ts
+static withIndicators(indicators): DynamicModule;
+```
+
+Defined in: [health/HealthModule.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/HealthModule.ts#L28)
+
+Registers additional health indicators.
+
+#### Parameters
+
+| Parameter    | Type                                                         | Description                                              |
+| ------------ | ------------------------------------------------------------ | -------------------------------------------------------- |
+| `indicators` | `Type`\<[`IHealthIndicator`](Interface.IHealthIndicator)\>[] | Array of indicator classes implementing IHealthIndicator |
+
+#### Returns
+
+`DynamicModule`

package/data/packages/platform-core/api/Class.HealthOrchestrator.md

@@ -0,0 +1,65 @@
+---
+title: 'Class: HealthOrchestrator'
+generated: true
+editUrl: false
+---
+
+# Class: HealthOrchestrator
+
+Defined in: [health/HealthOrchestrator.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/HealthOrchestrator.ts#L15)
+
+Orchestrates execution of all registered health indicators and aggregates their results.
+
+## Constructors
+
+### Constructor
+
+```ts
+new HealthOrchestrator(): HealthOrchestrator;
+```
+
+Defined in: [health/HealthOrchestrator.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/HealthOrchestrator.ts#L27)
+
+#### Returns
+
+`HealthOrchestrator`
+
+## Methods
+
+### check()
+
+```ts
+check(): Promise<IHealthCheckResult[]>;
+```
+
+Defined in: [health/HealthOrchestrator.ts:60](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/HealthOrchestrator.ts#L60)
+
+Executes all registered health indicators and aggregates their results.
+
+#### Returns
+
+`Promise`\<[`IHealthCheckResult`](Interface.IHealthCheckResult)[]\>
+
+The aggregated health check results.
+
+---
+
+### registerIndicator()
+
+```ts
+registerIndicator(indicator): void;
+```
+
+Defined in: [health/HealthOrchestrator.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/HealthOrchestrator.ts#L41)
+
+Registers a health indicator.
+
+#### Parameters
+
+| Parameter   | Type                                             | Description                       |
+| ----------- | ------------------------------------------------ | --------------------------------- |
+| `indicator` | [`IHealthIndicator`](Interface.IHealthIndicator) | The health indicator to register. |
+
+#### Returns
+
+`void`

package/data/packages/platform-core/api/Class.HostModule.md

@@ -0,0 +1,33 @@
+---
+title: 'Class: HostModule'
+generated: true
+editUrl: false
+---
+
+# Class: HostModule
+
+Defined in: [host/HostModule.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/host/HostModule.ts#L33)
+
+The `HostModule` provides host-related services globally.
+
+This module exports:
+
+- `HostService`: Provides access to host configuration (host URL, stage, version, etc.)
+- `ContentTemplateEngine`: Template engine for rendering dynamic content
+
+## Remarks
+
+This module is marked as `@Global()` so it only needs to be imported once
+in the root `AppModule`. All services are then available throughout the application.
+
+## Constructors
+
+### Constructor
+
+```ts
+new HostModule(): HostModule;
+```
+
+#### Returns
+
+`HostModule`