@breadstone/archipel-mcp 0.0.20 → 0.0.22

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

@@ -1,192 +0,0 @@
----
-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.HealthModule.md

@@ -1,42 +0,0 @@
----
-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

@@ -1,64 +0,0 @@
----
-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.MappingBuilder.md

@@ -1,110 +0,0 @@
----
-title: 'Class: MappingBuilder'
-generated: true
-editUrl: false
----
-# Class: MappingBuilder
-
-Defined in: [mapping/builder/MappingBuilder.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/builder/MappingBuilder.ts#L15)
-
-A mapping builder that uses the mapping service to register maps.
-
-## Implements
-
-- [`IMappingBuilder`](Interface.IMappingBuilder)
-
-## Constructors
-
-### Constructor
-
-```ts
-new MappingBuilder(service): MappingBuilder;
-```
-
-Defined in: [mapping/builder/MappingBuilder.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/builder/MappingBuilder.ts#L31)
-
-Constructs a new instance of the `MappingBuilder` class.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `service` | [`MappingService`](Class.MappingService) |
-
-#### Returns
-
-`MappingBuilder`
-
-## Methods
-
-### createKeyedMap()
-
-```ts
-createKeyedMap<TInput, TOutput>(key, fn): this;
-```
-
-Defined in: [mapping/builder/MappingBuilder.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/builder/MappingBuilder.ts#L68)
-
-Creates a keyed mapping between two types with full type safety.
-The mapping key encodes both input and output types at compile time.
-
-#### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `TInput` |
-| `TOutput` |
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | [`IMappingKey`](Interface.IMappingKey)\<`TInput`, `TOutput`\> | The type-safe mapping key. |
-| `fn` | (`source`) => `TOutput` | The mapping function. |
-
-#### Returns
-
-`this`
-
-#### Implementation of
-
-[`IMappingBuilder`](Interface.IMappingBuilder).[`createKeyedMap`](Interface.IMappingBuilder#createkeyedmap)
-
-***
-
-### createMap()
-
-```ts
-createMap<TSource, TDestination>(
-   source, 
-   destination, 
-   fn): this;
-```
-
-Defined in: [mapping/builder/MappingBuilder.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/builder/MappingBuilder.ts#L50)
-
-Creates a mapping between two types.
-Enforces compile-time type compatibility check.
-
-#### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `TSource` |
-| `TDestination` |
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `source` | `Constructor`\<`TSource`\> | The source type. |
-| `destination` | `Constructor`\<`TDestination`\> | The destination type. |
-| `fn` | (`source`) => `TDestination` | The mapping function. |
-
-#### Returns
-
-`this`
-
-#### Implementation of
-
-[`IMappingBuilder`](Interface.IMappingBuilder).[`createMap`](Interface.IMappingBuilder#createmap)

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

@@ -1,46 +0,0 @@
----
-title: 'Class: MappingModule'
-generated: true
-editUrl: false
----
-# Class: MappingModule
-
-Defined in: [mapping/MappingModule.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/MappingModule.ts#L23)
-
-Module that provides mapping services and allows registration of mapping profiles.
-
-## Constructors
-
-### Constructor
-
-```ts
-new MappingModule(): MappingModule;
-```
-
-#### Returns
-
-`MappingModule`
-
-## Methods
-
-### withProfiles()
-
-```ts
-static withProfiles(profiles): DynamicModule;
-```
-
-Defined in: [mapping/MappingModule.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/MappingModule.ts#L32)
-
-Configures the module with the given mapping profiles.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `profiles` | `Type`\<[`IMappingProfile`](Interface.IMappingProfile)\>[] | An array of mapping profile types to register. |
-
-#### Returns
-
-`DynamicModule`
-
-A dynamic module with the specified profiles registered.

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

@@ -1,56 +0,0 @@
----
-title: 'Class: MappingNotRegisteredError'
-generated: true
-editUrl: false
----
-# Class: MappingNotRegisteredError
-
-Defined in: [mapping/errors/MappingNotRegisteredError.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/errors/MappingNotRegisteredError.ts#L12)
-
-Thrown when a keyed mapping is requested but not registered.
-
-## Extends
-
-- `MappingError`
-
-## Constructors
-
-### Constructor
-
-```ts
-new MappingNotRegisteredError(key): MappingNotRegisteredError;
-```
-
-Defined in: [mapping/errors/MappingNotRegisteredError.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/errors/MappingNotRegisteredError.ts#L16)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `key` | `string` |
-
-#### Returns
-
-`MappingNotRegisteredError`
-
-#### Overrides
-
-```ts
-MappingError.constructor
-```
-
-## Properties
-
-### code
-
-```ts
-readonly code: string;
-```
-
-Defined in: [mapping/errors/MappingError.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/errors/MappingError.ts#L11)
-
-#### Inherited from
-
-```ts
-MappingError.code
-```

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

@@ -1,52 +0,0 @@
----
-title: 'Abstract Class: MappingProfileBase'
-generated: true
-editUrl: false
----
-# Abstract Class: MappingProfileBase
-
-Defined in: [mapping/profile/MappingProfileBase.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/profile/MappingProfileBase.ts#L13)
-
-Base class for mapping profiles to simplify implementation.
-
-## Implements
-
-- [`IMappingProfile`](Interface.IMappingProfile)
-
-## Constructors
-
-### Constructor
-
-```ts
-new MappingProfileBase(): MappingProfileBase;
-```
-
-#### Returns
-
-`MappingProfileBase`
-
-## Methods
-
-### configure()
-
-```ts
-abstract configure(builder): void;
-```
-
-Defined in: [mapping/profile/MappingProfileBase.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/profile/MappingProfileBase.ts#L25)
-
-Configures the mapping profile.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `builder` | [`IMappingBuilder`](Interface.IMappingBuilder) | The mapping builder. |
-
-#### Returns
-
-`void`
-
-#### Implementation of
-
-[`IMappingProfile`](Interface.IMappingProfile).[`configure`](Interface.IMappingProfile#configure)