@breadstone/archipel-mcp 0.0.1

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

@@ -0,0 +1,216 @@
+---
+title: 'Class: EmbeddedResourceStrategy'
+generated: true
+editUrl: false
+---
+
+# Class: EmbeddedResourceStrategy
+
+Defined in: [resources/strategies/EmbeddedResourceStrategy.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/EmbeddedResourceStrategy.ts#L14)
+
+Strategy for loading embedded resources from memory.
+
+## Implements
+
+- [`IResourceStrategy`](Interface.IResourceStrategy)
+
+## Constructors
+
+### Constructor
+
+```ts
+new EmbeddedResourceStrategy(resources?): EmbeddedResourceStrategy;
+```
+
+Defined in: [resources/strategies/EmbeddedResourceStrategy.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/EmbeddedResourceStrategy.ts#L30)
+
+Constructs a new instance of the `EmbeddedResourceStrategy` class.
+
+#### Parameters
+
+| Parameter   | Type                           |
+| ----------- | ------------------------------ |
+| `resources` | `Record`\<`string`, `string`\> |
+
+#### Returns
+
+`EmbeddedResourceStrategy`
+
+## Accessors
+
+### name
+
+#### Get Signature
+
+```ts
+get name(): string;
+```
+
+Defined in: [resources/strategies/EmbeddedResourceStrategy.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/EmbeddedResourceStrategy.ts#L38)
+
+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/EmbeddedResourceStrategy.ts:94](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/EmbeddedResourceStrategy.ts#L94)
+
+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/EmbeddedResourceStrategy.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/EmbeddedResourceStrategy.ts#L105)
+
+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/EmbeddedResourceStrategy.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/EmbeddedResourceStrategy.ts#L53)
+
+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/EmbeddedResourceStrategy.ts:83](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/EmbeddedResourceStrategy.ts#L83)
+
+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)
+
+---
+
+### register()
+
+```ts
+register(key, content): void;
+```
+
+Defined in: [resources/strategies/EmbeddedResourceStrategy.ts:116](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/EmbeddedResourceStrategy.ts#L116)
+
+Registers a new embedded resource.
+
+#### Parameters
+
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `key`     | `string` | The resource key     |
+| `content` | `string` | The resource content |
+
+#### Returns
+
+`void`
+
+---
+
+### whatDoIHave()
+
+```ts
+whatDoIHave(): void;
+```
+
+Defined in: [resources/strategies/EmbeddedResourceStrategy.ts:125](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/EmbeddedResourceStrategy.ts#L125)
+
+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.EnvironmentConfigStrategy.md

@@ -0,0 +1,144 @@
+---
+title: 'Class: EnvironmentConfigStrategy'
+generated: true
+editUrl: false
+---
+
+# Class: EnvironmentConfigStrategy
+
+Defined in: [config/strategies/EnvironmentConfigStrategy.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/EnvironmentConfigStrategy.ts#L14)
+
+The `EnvironmentConfigStrategy` class.
+
+## Extends
+
+- [`ConfigStrategyBase`](Class.ConfigStrategyBase)
+
+## Constructors
+
+### Constructor
+
+```ts
+new EnvironmentConfigStrategy(): EnvironmentConfigStrategy;
+```
+
+Defined in: [config/strategies/EnvironmentConfigStrategy.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/EnvironmentConfigStrategy.ts#L24)
+
+#### Returns
+
+`EnvironmentConfigStrategy`
+
+#### Overrides
+
+```ts
+ConfigStrategyBase.constructor;
+```
+
+## Methods
+
+### has()
+
+```ts
+has(key): boolean;
+```
+
+Defined in: [config/strategies/EnvironmentConfigStrategy.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/EnvironmentConfigStrategy.ts#L58)
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `key`     | `string` |
+
+#### Returns
+
+`boolean`
+
+#### Overrides
+
+[`ConfigStrategyBase`](Class.ConfigStrategyBase).[`has`](Class.ConfigStrategyBase#has)
+
+---
+
+### initialize()
+
+```ts
+initialize(): void;
+```
+
+Defined in: [config/strategies/EnvironmentConfigStrategy.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/EnvironmentConfigStrategy.ts#L33)
+
+`initialize` - Initializes the configuration.
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`ConfigStrategyBase`](Class.ConfigStrategyBase).[`initialize`](Class.ConfigStrategyBase#initialize)
+
+---
+
+### resolve()
+
+```ts
+resolve<T>(key): T;
+```
+
+Defined in: [config/strategies/EnvironmentConfigStrategy.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/EnvironmentConfigStrategy.ts#L37)
+
+`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/EnvironmentConfigStrategy.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/EnvironmentConfigStrategy.ts#L47)
+
+#### 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.ErrorTemplateService.md

@@ -0,0 +1,110 @@
+---
+title: 'Class: ErrorTemplateService'
+generated: true
+editUrl: false
+---
+
+# Class: ErrorTemplateService
+
+Defined in: [services/ErrorTemplateService.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L81)
+
+Service for rendering error page templates.
+
+## Constructors
+
+### Constructor
+
+```ts
+new ErrorTemplateService(
+   configService,
+   contentTemplateEngine,
+   resourceManager): ErrorTemplateService;
+```
+
+Defined in: [services/ErrorTemplateService.ts:98](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L98)
+
+Constructs a new instance of the `ErrorTemplateService` class.
+
+#### Parameters
+
+| Parameter               | Type                                                   |
+| ----------------------- | ------------------------------------------------------ |
+| `configService`         | [`ConfigService`](Class.ConfigService)                 |
+| `contentTemplateEngine` | [`ContentTemplateEngine`](Class.ContentTemplateEngine) |
+| `resourceManager`       | [`ResourceManager`](Class.ResourceManager)             |
+
+#### Returns
+
+`ErrorTemplateService`
+
+## Methods
+
+### getErrorMessage()
+
+```ts
+getErrorMessage(statusCode): string;
+```
+
+Defined in: [services/ErrorTemplateService.ts:184](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L184)
+
+Gets a human-readable error message based on status code.
+
+#### Parameters
+
+| Parameter    | Type     | Description           |
+| ------------ | -------- | --------------------- |
+| `statusCode` | `number` | The HTTP status code. |
+
+#### Returns
+
+`string`
+
+The error message.
+
+---
+
+### getErrorPageContent()
+
+```ts
+getErrorPageContent(params): Promise<string>;
+```
+
+Defined in: [services/ErrorTemplateService.ts:119](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L119)
+
+Retrieves the error page HTML content.
+
+#### Parameters
+
+| Parameter | Type                                             | Description                |
+| --------- | ------------------------------------------------ | -------------------------- |
+| `params`  | [`IErrorPageParams`](Interface.IErrorPageParams) | The error page parameters. |
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The rendered HTML content.
+
+---
+
+### getErrorTitle()
+
+```ts
+getErrorTitle(statusCode): string;
+```
+
+Defined in: [services/ErrorTemplateService.ts:155](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L155)
+
+Gets a human-readable error title based on status code.
+
+#### Parameters
+
+| Parameter    | Type     | Description           |
+| ------------ | -------- | --------------------- |
+| `statusCode` | `number` | The HTTP status code. |
+
+#### Returns
+
+`string`
+
+The error title.

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

@@ -0,0 +1,164 @@
+---
+title: 'Class: EventHub'
+generated: true
+editUrl: false
+---
+
+# Class: EventHub
+
+Defined in: [events/EventHub.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L38)
+
+Provides a strongly typed event hub that can publish and subscribe to events.
+
+## Implements
+
+- `OnModuleDestroy`
+
+## Constructors
+
+### Constructor
+
+```ts
+new EventHub(): EventHub;
+```
+
+Defined in: [events/EventHub.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L51)
+
+Initializes a new instance of the EventHub class.
+
+#### Returns
+
+`EventHub`
+
+## Accessors
+
+### events
+
+#### Get Signature
+
+```ts
+get events(): Observable<AnyEventNotification>;
+```
+
+Defined in: [events/EventHub.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L65)
+
+Gets the observable sequence that exposes all events published within the hub.
+
+##### Returns
+
+`Observable`\<`AnyEventNotification`\>
+
+## Methods
+
+### observe()
+
+```ts
+observe<TEvents, TKey>(eventKey): Observable<TEvents[TKey]>;
+```
+
+Defined in: [events/EventHub.ts:118](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L118)
+
+Returns an observable that emits payloads for the specified event.
+
+#### Type Parameters
+
+| Type Parameter                                         |
+| ------------------------------------------------------ |
+| `TEvents` _extends_ [`IEventMap`](Interface.IEventMap) |
+| `TKey` _extends_ `string` \| `number` \| `symbol`      |
+
+#### Parameters
+
+| Parameter  | Type                                                    | Description              |
+| ---------- | ------------------------------------------------------- | ------------------------ |
+| `eventKey` | [`IEventKey`](Interface.IEventKey)\<`TEvents`, `TKey`\> | The event key to observe |
+
+#### Returns
+
+`Observable`\<`TEvents`\[`TKey`\]\>
+
+An observable sequence that emits payloads of the specified event
+
+---
+
+### onModuleDestroy()
+
+```ts
+onModuleDestroy(): void;
+```
+
+Defined in: [events/EventHub.ts:134](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L134)
+
+Completes the event stream when the module is destroyed.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+```ts
+OnModuleDestroy.onModuleDestroy;
+```
+
+---
+
+### publish()
+
+```ts
+publish<TEvents, TKey>(eventKey, payload): void;
+```
+
+Defined in: [events/EventHub.ts:80](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L80)
+
+Publishes an event with the specified payload to all subscribers.
+
+#### Type Parameters
+
+| Type Parameter                                         |
+| ------------------------------------------------------ |
+| `TEvents` _extends_ [`IEventMap`](Interface.IEventMap) |
+| `TKey` _extends_ `string` \| `number` \| `symbol`      |
+
+#### Parameters
+
+| Parameter  | Type                                                    | Description                                |
+| ---------- | ------------------------------------------------------- | ------------------------------------------ |
+| `eventKey` | [`IEventKey`](Interface.IEventKey)\<`TEvents`, `TKey`\> | The event key identifying the target event |
+| `payload`  | `TEvents`\[`TKey`\]                                     | The payload associated with the event      |
+
+#### Returns
+
+`void`
+
+---
+
+### subscribe()
+
+```ts
+subscribe<TEvents, TKey>(eventKey, handler): Subscription;
+```
+
+Defined in: [events/EventHub.ts:101](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L101)
+
+Subscribes to the specified event and invokes the handler whenever the event is published.
+
+#### Type Parameters
+
+| Type Parameter                                         |
+| ------------------------------------------------------ |
+| `TEvents` _extends_ [`IEventMap`](Interface.IEventMap) |
+| `TKey` _extends_ `string` \| `number` \| `symbol`      |
+
+#### Parameters
+
+| Parameter  | Type                                                    | Description                                           |
+| ---------- | ------------------------------------------------------- | ----------------------------------------------------- |
+| `eventKey` | [`IEventKey`](Interface.IEventKey)\<`TEvents`, `TKey`\> | The event key to subscribe to                         |
+| `handler`  | (`payload`) => `void`                                   | The handler that is invoked when the event is emitted |
+
+#### Returns
+
+`Subscription`
+
+The subscription that can be disposed to unsubscribe from the event stream

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

@@ -0,0 +1,23 @@
+---
+title: 'Class: EventModule'
+generated: true
+editUrl: false
+---
+
+# Class: EventModule
+
+Defined in: [events/EventModule.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventModule.ts#L22)
+
+Module that provides event hub services.
+
+## Constructors
+
+### Constructor
+
+```ts
+new EventModule(): EventModule;
+```
+
+#### Returns
+
+`EventModule`