npm - @breadstone/archipel-mcp - Versions diffs - 0.0.8 → 0.0.10 - Mend

@breadstone/archipel-mcp 0.0.8 → 0.0.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (569) hide show

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

@@ -3,7 +3,6 @@ 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)
@@ -23,12 +22,12 @@ Defined in: [resources/strategies/FileResourceStrategy.ts:24](https://github.com
 Base paths to search for resources.
 Paths are tried in order until the resource is found.
----
+***
 ### defaultEncoding?
 ```ts
-optional defaultEncoding?:
+optional defaultEncoding?:
   | "ascii"
   | "utf8"
   | "utf-8"
@@ -49,10 +48,10 @@ Optional default encoding for text files.
 #### Default
 ```ts
-'utf-8';
+'utf-8'
 ```
----
+***
 ### includeSubfolders?
@@ -69,5 +68,5 @@ of the base paths using glob patterns.
 #### Default
 ```ts
-false;
+false
 ```

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

@@ -3,7 +3,6 @@ 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)
@@ -22,7 +21,7 @@ Defined in: [health/IHealthCheckResult.ts:21](https://github.com/RueDeRennes/arc
 Optional additional details about the health check.
----
+***
 ### name
@@ -34,12 +33,12 @@ Defined in: [health/IHealthCheckResult.ts:11](https://github.com/RueDeRennes/arc
 The name of the health indicator (e.g., 'database', 'app').
----
+***
 ### status
 ```ts
-status: 'up' | 'down';
+status: "up" | "down";
 ```
 Defined in: [health/IHealthCheckResult.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/IHealthCheckResult.ts#L16)

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

@@ -3,7 +3,6 @@ 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)
@@ -27,7 +26,7 @@ Unique key identifying the indicator
 ### check()
 ```ts
-check():
+check():
   | HealthIndicatorResult<string>
 | Promise<HealthIndicatorResult<string>>;
 ```
@@ -38,5 +37,5 @@ Performs the health check and returns a result keyed by the indicator key
 #### Returns
-\| `HealthIndicatorResult`\<`string`\>
-\| `Promise`\<`HealthIndicatorResult`\<`string`\>\>
+  \| `HealthIndicatorResult`\<`string`\>
+  \| `Promise`\<`HealthIndicatorResult`\<`string`\>\>

package/data/packages/platform-core/api/Interface.IHostContentParams.md CHANGED Viewed

@@ -3,10 +3,9 @@ title: 'Interface: IHostContentParams'
 generated: true
 editUrl: false
 ---
 # Interface: IHostContentParams
-Defined in: [services/HostService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L18)
+Defined in: [services/HostService.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L19)
 Parameters for generating host content.
@@ -41,7 +40,7 @@ link: string;
 The link URL for the action.
----
+***
 ### data?
@@ -49,11 +48,11 @@ The link URL for the action.
 optional data?: Record<string, unknown>;
 ```
-Defined in: [services/HostService.ts:131](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L131)
+Defined in: [services/HostService.ts:126](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L126)
 Optional additional data to be injected into the template.
----
+***
 ### description
@@ -65,7 +64,7 @@ Defined in: [services/HostService.ts:28](https://github.com/RueDeRennes/archipel
 The subtitle/description of the page.
----
+***
 ### features?
@@ -78,7 +77,7 @@ optional features?: {
 }[];
 ```
-Defined in: [services/HostService.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L54)
+Defined in: [services/HostService.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L53)
 Optional array of feature cards.
@@ -114,7 +113,7 @@ title: string;
 The title of the feature.
----
+***
 ### footer?
@@ -130,7 +129,7 @@ optional footer?: {
 };
 ```
-Defined in: [services/HostService.ts:94](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L94)
+Defined in: [services/HostService.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L91)
 Optional footer configuration.
@@ -169,7 +168,7 @@ optional version?: string;
 Optional version string.
----
+***
 ### health?
@@ -177,11 +176,11 @@ Optional version string.
 optional health?: IHealthCheckResult[];
 ```
-Defined in: [services/HostService.ts:89](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L89)
+Defined in: [services/HostService.ts:86](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L86)
 Optional health check result to display.
----
+***
 ### logo
@@ -193,7 +192,7 @@ Defined in: [services/HostService.ts:33](https://github.com/RueDeRennes/archipel
 The logo URL (can be a regular URL or data URL).
----
+***
 ### style?
@@ -204,7 +203,7 @@ optional style?: {
 };
 ```
-Defined in: [services/HostService.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L81)
+Defined in: [services/HostService.ts:78](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L78)
 Optional style configuration.
@@ -220,7 +219,7 @@ primary: string;
 secondary: string;
 ```
----
+***
 ### title

package/data/packages/platform-core/api/Interface.IIdGenerator.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Interface: IIdGenerator'
 generated: true
 editUrl: false
 ---
 # Interface: IIdGenerator
 Defined in: [identifiers/generators/interfaces/IIdGenerator.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/interfaces/IIdGenerator.ts#L4)
@@ -24,16 +23,16 @@ Generates a new ID
 #### Parameters
-| Parameter  | Type     | Description                          |
-| ---------- | -------- | ------------------------------------ |
-| `prefix?`  | `string` | Optional prefix to prepend to the ID |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `prefix?` | `string` | Optional prefix to prepend to the ID |
 | `postfix?` | `string` | Optional postfix to append to the ID |
 #### Returns
 `string`
----
+***
 ### isValid()
@@ -47,9 +46,9 @@ Validates if the given ID conforms to the expected format
 #### Parameters
-| Parameter | Type     | Description        |
-| --------- | -------- | ------------------ |
-| `id`      | `string` | The ID to validate |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The ID to validate |
 #### Returns

package/data/packages/platform-core/api/Interface.IMappingBuilder.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Interface: IMappingBuilder'
 generated: true
 editUrl: false
 ---
 # Interface: IMappingBuilder
 Defined in: [mapping/builder/interfaces/IMappingBuilder.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/builder/interfaces/IMappingBuilder.ts#L18)
@@ -26,29 +25,29 @@ The mapping key encodes both input and output types at compile time.
 #### Type Parameters
 | Type Parameter |
-| -------------- |
-| `TInput`       |
-| `TOutput`      |
+| ------ |
+| `TInput` |
+| `TOutput` |
 #### Parameters
-| Parameter | Type                                                                 | Description                                                |
-| --------- | -------------------------------------------------------------------- | ---------------------------------------------------------- |
-| `key`     | [`IMappingKey`](Interface.IMappingKey)\<`TInput`, `TOutput`\>        | The type-safe mapping key.                                 |
-| `fn`      | (`source`) => `MappingCompatible`\<`TInput`, `TOutput`\> & `TOutput` | The mapping function that must return a valid destination. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | [`IMappingKey`](Interface.IMappingKey)\<`TInput`, `TOutput`\> | The type-safe mapping key. |
+| `fn` | (`source`) => `MappingCompatible`\<`TInput`, `TOutput`\> & `TOutput` | The mapping function that must return a valid destination. |
 #### Returns
 `this`
----
+***
 ### createMap()
 ```ts
 createMap<TSource, TDestination>(
-   source,
-   destination,
+   source,
+   destination,
    fn): this;
 ```
@@ -60,17 +59,17 @@ Ensures compile-time type compatibility between source and destination.
 #### Type Parameters
 | Type Parameter |
-| -------------- |
-| `TSource`      |
+| ------ |
+| `TSource` |
 | `TDestination` |
 #### Parameters
-| Parameter     | Type                                                                            | Description                                                |
-| ------------- | ------------------------------------------------------------------------------- | ---------------------------------------------------------- |
-| `source`      | `Constructor`\<`TSource`\>                                                      | The source type.                                           |
-| `destination` | `Constructor`\<`TDestination`\>                                                 | The destination type.                                      |
-| `fn`          | (`source`) => `MappingCompatible`\<`TSource`, `TDestination`\> & `TDestination` | The mapping function that must return a valid destination. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `source` | `Constructor`\<`TSource`\> | The source type. |
+| `destination` | `Constructor`\<`TDestination`\> | The destination type. |
+| `fn` | (`source`) => `MappingCompatible`\<`TSource`, `TDestination`\> & `TDestination` | The mapping function that must return a valid destination. |
 #### Returns

package/data/packages/platform-core/api/Interface.IMappingKey.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Interface: IMappingKey\<TInput, TOutput\>'
 generated: true
 editUrl: false
 ---
 # Interface: IMappingKey\<TInput, TOutput\>
 Defined in: [mapping/types/MappingKey.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L9)
@@ -13,10 +12,10 @@ This ensures compile-time type safety when using the mapping service.
 ## Type Parameters
-| Type Parameter | Description                      |
-| -------------- | -------------------------------- |
-| `TInput`       | The input type for the mapping.  |
-| `TOutput`      | The output type for the mapping. |
+| Type Parameter | Description |
+| ------ | ------ |
+| `TInput` | The input type for the mapping. |
+| `TOutput` | The output type for the mapping. |
 ## Properties
@@ -28,7 +27,7 @@ readonly _brand: "MappingKey";
 Defined in: [mapping/types/MappingKey.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L10)
----
+***
 ### \_input
@@ -38,7 +37,7 @@ readonly _input: TInput;
 Defined in: [mapping/types/MappingKey.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L11)
----
+***
 ### \_output
@@ -48,7 +47,7 @@ readonly _output: TOutput;
 Defined in: [mapping/types/MappingKey.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L12)
----
+***
 ### key

package/data/packages/platform-core/api/Interface.IMappingProfile.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Interface: IMappingProfile'
 generated: true
 editUrl: false
 ---
 # Interface: IMappingProfile
 Defined in: [mapping/profile/interfaces/IMappingProfile.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/profile/interfaces/IMappingProfile.ts#L12)
@@ -24,8 +23,8 @@ Configures the mapping profile.
 #### Parameters
-| Parameter | Type                                           | Description          |
-| --------- | ---------------------------------------------- | -------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `builder` | [`IMappingBuilder`](Interface.IMappingBuilder) | The mapping builder. |
 #### Returns

package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Interface: IResourceManagerConfig'
 generated: true
 editUrl: false
 ---
 # Interface: IResourceManagerConfig
 Defined in: [resources/ResourceManager.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L16)
@@ -18,11 +17,11 @@ Configuration for the ResourceManager.
 optional cache?: ILayeredCache<string, IResourceResult>;
 ```
-Defined in: [resources/ResourceManager.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L27)
+Defined in: [resources/ResourceManager.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L26)
 Optional cache for loaded resources.
----
+***
 ### cacheTtl?
@@ -30,7 +29,7 @@ Optional cache for loaded resources.
 optional cacheTtl?: number;
 ```
-Defined in: [resources/ResourceManager.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L33)
+Defined in: [resources/ResourceManager.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L32)
 Cache TTL in seconds.
@@ -40,7 +39,7 @@ Cache TTL in seconds.
 3600 (1 hour)
 ```
----
+***
 ### debug?
@@ -48,17 +47,17 @@ Cache TTL in seconds.
 optional debug?: boolean;
 ```
-Defined in: [resources/ResourceManager.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L39)
+Defined in: [resources/ResourceManager.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L38)
 Enable debug logging.
 #### Default
 ```ts
-false;
+false
 ```
----
+***
 ### strategies
@@ -66,7 +65,7 @@ false;
 strategies: IResourceStrategy[];
 ```
-Defined in: [resources/ResourceManager.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L22)
+Defined in: [resources/ResourceManager.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L21)
 Resource loading strategies in priority order.
 First strategy that finds the resource wins.

package/data/packages/platform-core/api/Interface.IResourceMetadata.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Interface: IResourceMetadata'
 generated: true
 editUrl: false
 ---
 # Interface: IResourceMetadata
 Defined in: [resources/types/IResourceMetadata.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L6)
@@ -22,7 +21,7 @@ Defined in: [resources/types/IResourceMetadata.ts:41](https://github.com/RueDeRe
 When this resource was cached (if applicable).
----
+***
 ### encoding?
@@ -34,7 +33,7 @@ Defined in: [resources/types/IResourceMetadata.ts:31](https://github.com/RueDeRe
 The encoding of the resource (if applicable).
----
+***
 ### key
@@ -46,7 +45,7 @@ Defined in: [resources/types/IResourceMetadata.ts:11](https://github.com/RueDeRe
 The resource key/identifier.
----
+***
 ### mimeType
@@ -58,7 +57,7 @@ Defined in: [resources/types/IResourceMetadata.ts:21](https://github.com/RueDeRe
 The MIME type of the resource.
----
+***
 ### path
@@ -70,7 +69,7 @@ Defined in: [resources/types/IResourceMetadata.ts:16](https://github.com/RueDeRe
 The full path of the resource.
----
+***
 ### size
@@ -82,7 +81,7 @@ Defined in: [resources/types/IResourceMetadata.ts:26](https://github.com/RueDeRe
 The size of the resource in bytes.
----
+***
 ### source

package/data/packages/platform-core/api/Interface.IResourceResult.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Interface: IResourceResult'
 generated: true
 editUrl: false
 ---
 # Interface: IResourceResult
 Defined in: [resources/types/IResourceResult.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceResult.ts#L8)
@@ -22,7 +21,7 @@ Defined in: [resources/types/IResourceResult.ts:13](https://github.com/RueDeRenn
 The resource content as a Buffer.
----
+***
 ### metadata

package/data/packages/platform-core/api/Interface.IResourceStrategy.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Interface: IResourceStrategy'
 generated: true
 editUrl: false
 ---
 # Interface: IResourceStrategy
 Defined in: [resources/strategies/abstracts/IResourceStrategy.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/abstracts/IResourceStrategy.ts#L8)
@@ -36,9 +35,9 @@ Checks if a resource exists without loading it.
 #### Parameters
-| Parameter | Type     | Description                 |
-| --------- | -------- | --------------------------- |
-| `key`     | `string` | The resource key/identifier |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The resource key/identifier |
 #### Returns
@@ -46,7 +45,7 @@ Checks if a resource exists without loading it.
 True if the resource exists
----
+***
 ### existsAsync()
@@ -60,9 +59,9 @@ Checks if a resource exists without loading it (asynchronous).
 #### Parameters
-| Parameter | Type     | Description                 |
-| --------- | -------- | --------------------------- |
-| `key`     | `string` | The resource key/identifier |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The resource key/identifier |
 #### Returns
@@ -70,7 +69,7 @@ Checks if a resource exists without loading it (asynchronous).
 Promise resolving to true if the resource exists
----
+***
 ### load()
@@ -84,9 +83,9 @@ Loads a resource by its key.
 #### Parameters
-| Parameter | Type     | Description                 |
-| --------- | -------- | --------------------------- |
-| `key`     | `string` | The resource key/identifier |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The resource key/identifier |
 #### Returns
@@ -94,7 +93,7 @@ Loads a resource by its key.
 The resource result or undefined if not found
----
+***
 ### loadAsync()
@@ -108,9 +107,9 @@ Loads a resource by its key (asynchronous).
 #### Parameters
-| Parameter | Type     | Description                 |
-| --------- | -------- | --------------------------- |
-| `key`     | `string` | The resource key/identifier |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The resource key/identifier |
 #### Returns
@@ -118,7 +117,7 @@ Loads a resource by its key (asynchronous).
 Promise resolving to the resource result or undefined if not found
----
+***
 ### whatDoIHave()

package/data/packages/platform-core/api/Interface.ISseEventData.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Interface: ISseEventData\<TData\>'
 generated: true
 editUrl: false
 ---
 # Interface: ISseEventData\<TData\>
 Defined in: [sse/services/interfaces/ISseEventData.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/interfaces/ISseEventData.ts#L7)
@@ -13,8 +12,8 @@ Represents the data of a Server-Sent Event.
 ## Type Parameters
 | Type Parameter | Default type |
-| -------------- | ------------ |
-| `TData`        | `unknown`    |
+| ------ | ------ |
+| `TData` | `unknown` |
 ## Properties
@@ -26,7 +25,7 @@ readonly action: `${string}:${string}`;
 Defined in: [sse/services/interfaces/ISseEventData.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/interfaces/ISseEventData.ts#L11)
----
+***
 ### payload