@breadstone/archipel-mcp 0.0.2 → 0.0.4

package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md

@@ -3,6 +3,7 @@ title: 'Class: TelemetryFacade'
 generated: true
 editUrl: false
 ---
+
 # Class: TelemetryFacade
 
 Defined in: [core/TelemetryFacade.ts:3](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/core/TelemetryFacade.ts#L3)
@@ -37,7 +38,7 @@ Defined in: [core/TelemetryFacade.ts:45](https://github.com/RueDeRennes/archipel
 
 `Logger`
 
-***
+---
 
 ### recordCacheEvent()
 
@@ -49,12 +50,12 @@ Defined in: [core/TelemetryFacade.ts:25](https://github.com/RueDeRennes/archipel
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `event` | \{ `cache`: `string`; `outcome`: `string`; `phase?`: `string`; \} |
-| `event.cache` | `string` |
-| `event.outcome` | `string` |
-| `event.phase?` | `string` |
+| Parameter       | Type                                                              |
+| --------------- | ----------------------------------------------------------------- |
+| `event`         | \{ `cache`: `string`; `outcome`: `string`; `phase?`: `string`; \} |
+| `event.cache`   | `string`                                                          |
+| `event.outcome` | `string`                                                          |
+| `event.phase?`  | `string`                                                          |
 
 #### Returns
 
@@ -64,15 +65,15 @@ Defined in: [core/TelemetryFacade.ts:25](https://github.com/RueDeRennes/archipel
 
 [`ITelemetryFacade`](Interface.ITelemetryFacade).[`recordCacheEvent`](Interface.ITelemetryFacade#recordcacheevent)
 
-***
+---
 
 ### recordClientMetric()
 
 ```ts
 recordClientMetric(
-   name, 
-   type, 
-   value, 
+   name,
+   type,
+   value,
    labels?): void;
 ```
 
@@ -80,11 +81,11 @@ Defined in: [core/TelemetryFacade.ts:35](https://github.com/RueDeRennes/archipel
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `name` | `string` |
-| `type` | `string` |
-| `value` | `number` |
+| Parameter | Type                           |
+| --------- | ------------------------------ |
+| `name`    | `string`                       |
+| `type`    | `string`                       |
+| `value`   | `number`                       |
 | `labels?` | `Record`\<`string`, `string`\> |
 
 #### Returns
@@ -95,7 +96,7 @@ Defined in: [core/TelemetryFacade.ts:35](https://github.com/RueDeRennes/archipel
 
 [`ITelemetryFacade`](Interface.ITelemetryFacade).[`recordClientMetric`](Interface.ITelemetryFacade#recordclientmetric)
 
-***
+---
 
 ### runOperation()
 
@@ -108,15 +109,15 @@ Defined in: [core/TelemetryFacade.ts:7](https://github.com/RueDeRennes/archipel/
 #### Type Parameters
 
 | Type Parameter |
-| ------ |
-| `T` |
+| -------------- |
+| `T`            |
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `name` | `string` |
-| `fn` | () => `T` \| `Promise`\<`T`\> |
+| Parameter | Type                          |
+| --------- | ----------------------------- |
+| `name`    | `string`                      |
+| `fn`      | () => `T` \| `Promise`\<`T`\> |
 
 #### Returns
 

package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md

@@ -3,6 +3,7 @@ title: 'Class: TelemetryLoggerService'
 generated: true
 editUrl: false
 ---
+
 # Class: TelemetryLoggerService
 
 Defined in: [logger/TelemetryLoggerService.ts:5](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/logger/TelemetryLoggerService.ts#L5)
@@ -27,8 +28,8 @@ Defined in: [logger/TelemetryLoggerService.ts:12](https://github.com/RueDeRennes
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
+| Parameter     | Type                                               |
+| ------------- | -------------------------------------------------- |
 | `ruleEngine?` | [`TelemetryRuleEngine`](Class.TelemetryRuleEngine) |
 
 #### Returns
@@ -38,7 +39,7 @@ Defined in: [logger/TelemetryLoggerService.ts:12](https://github.com/RueDeRennes
 #### Overrides
 
 ```ts
-ConsoleLogger.constructor
+ConsoleLogger.constructor;
 ```
 
 ## Methods
@@ -56,9 +57,9 @@ Prints to `stdout` with newline.
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `message` | `string` |
+| Parameter  | Type     |
+| ---------- | -------- |
+| `message`  | `string` |
 | `context?` | `string` |
 
 #### Returns
@@ -68,23 +69,23 @@ Prints to `stdout` with newline.
 #### Implementation of
 
 ```ts
-LoggerService.debug
+LoggerService.debug;
 ```
 
 #### Overrides
 
 ```ts
-ConsoleLogger.debug
+ConsoleLogger.debug;
 ```
 
-***
+---
 
 ### error()
 
 ```ts
 error(
-   message, 
-   stack?, 
+   message,
+   stack?,
    context?): void;
 ```
 
@@ -95,10 +96,10 @@ Prints to `stderr` with newline.
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `message` | `string` |
-| `stack?` | `string` |
+| Parameter  | Type     |
+| ---------- | -------- |
+| `message`  | `string` |
+| `stack?`   | `string` |
 | `context?` | `string` |
 
 #### Returns
@@ -108,16 +109,16 @@ Prints to `stderr` with newline.
 #### Implementation of
 
 ```ts
-LoggerService.error
+LoggerService.error;
 ```
 
 #### Overrides
 
 ```ts
-ConsoleLogger.error
+ConsoleLogger.error;
 ```
 
-***
+---
 
 ### log()
 
@@ -132,9 +133,9 @@ Prints to `stdout` with newline.
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `message` | `string` |
+| Parameter  | Type     |
+| ---------- | -------- |
+| `message`  | `string` |
 | `context?` | `string` |
 
 #### Returns
@@ -144,16 +145,16 @@ Prints to `stdout` with newline.
 #### Implementation of
 
 ```ts
-LoggerService.log
+LoggerService.log;
 ```
 
 #### Overrides
 
 ```ts
-ConsoleLogger.log
+ConsoleLogger.log;
 ```
 
-***
+---
 
 ### verbose()
 
@@ -168,9 +169,9 @@ Prints to `stdout` with newline.
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `message` | `string` |
+| Parameter  | Type     |
+| ---------- | -------- |
+| `message`  | `string` |
 | `context?` | `string` |
 
 #### Returns
@@ -180,16 +181,16 @@ Prints to `stdout` with newline.
 #### Implementation of
 
 ```ts
-LoggerService.verbose
+LoggerService.verbose;
 ```
 
 #### Overrides
 
 ```ts
-ConsoleLogger.verbose
+ConsoleLogger.verbose;
 ```
 
-***
+---
 
 ### warn()
 
@@ -204,9 +205,9 @@ Prints to `stdout` with newline.
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `message` | `string` |
+| Parameter  | Type     |
+| ---------- | -------- |
+| `message`  | `string` |
 | `context?` | `string` |
 
 #### Returns
@@ -216,11 +217,11 @@ Prints to `stdout` with newline.
 #### Implementation of
 
 ```ts
-LoggerService.warn
+LoggerService.warn;
 ```
 
 #### Overrides
 
 ```ts
-ConsoleLogger.warn
+ConsoleLogger.warn;
 ```

package/data/packages/platform-telemetry/api/Class.TelemetryModule.md

@@ -3,6 +3,7 @@ title: 'Class: TelemetryModule'
 generated: true
 editUrl: false
 ---
+
 # Class: TelemetryModule
 
 Defined in: [TelemetryModule.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/TelemetryModule.ts#L15)
@@ -31,8 +32,8 @@ Defined in: [TelemetryModule.ts:17](https://github.com/RueDeRennes/archipel/blob
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
+| Parameter | Type                                                            |
+| --------- | --------------------------------------------------------------- |
 | `options` | `Partial`\<[`ITelemetryOptions`](Interface.ITelemetryOptions)\> |
 
 #### Returns

package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md

@@ -3,6 +3,7 @@ title: 'Class: TelemetryRuleEngine'
 generated: true
 editUrl: false
 ---
+
 # Class: TelemetryRuleEngine
 
 Defined in: [rules/TelemetryRuleEngine.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/rules/TelemetryRuleEngine.ts#L7)
@@ -19,8 +20,8 @@ Defined in: [rules/TelemetryRuleEngine.ts:14](https://github.com/RueDeRennes/arc
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
+| Parameter | Type                                               |
+| --------- | -------------------------------------------------- |
 | `options` | [`ITelemetryOptions`](Interface.ITelemetryOptions) |
 
 #### Returns
@@ -39,8 +40,8 @@ Defined in: [rules/TelemetryRuleEngine.ts:18](https://github.com/RueDeRennes/arc
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
+| Parameter | Type     |
+| --------- | -------- |
 | `message` | `string` |
 
 #### Returns

package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md

@@ -3,6 +3,7 @@ title: 'Interface: ITelemetryFacade'
 generated: true
 editUrl: false
 ---
+
 # Interface: ITelemetryFacade
 
 Defined in: [core/NoopTelemetryFacade.ts:1](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/core/NoopTelemetryFacade.ts#L1)
@@ -19,26 +20,26 @@ Defined in: [core/NoopTelemetryFacade.ts:3](https://github.com/RueDeRennes/archi
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `event` | \{ `cache`: `string`; `outcome`: `string`; `phase?`: `string`; \} |
-| `event.cache` | `string` |
-| `event.outcome` | `string` |
-| `event.phase?` | `string` |
+| Parameter       | Type                                                              |
+| --------------- | ----------------------------------------------------------------- |
+| `event`         | \{ `cache`: `string`; `outcome`: `string`; `phase?`: `string`; \} |
+| `event.cache`   | `string`                                                          |
+| `event.outcome` | `string`                                                          |
+| `event.phase?`  | `string`                                                          |
 
 #### Returns
 
 `void`
 
-***
+---
 
 ### recordClientMetric()?
 
 ```ts
 optional recordClientMetric(
-   name, 
-   type, 
-   value, 
+   name,
+   type,
+   value,
    labels?): void;
 ```
 
@@ -46,18 +47,18 @@ Defined in: [core/NoopTelemetryFacade.ts:8](https://github.com/RueDeRennes/archi
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `name` | `string` |
-| `type` | `string` |
-| `value` | `number` |
+| Parameter | Type                           |
+| --------- | ------------------------------ |
+| `name`    | `string`                       |
+| `type`    | `string`                       |
+| `value`   | `number`                       |
 | `labels?` | `Record`\<`string`, `string`\> |
 
 #### Returns
 
 `void`
 
-***
+---
 
 ### runOperation()
 
@@ -70,15 +71,15 @@ Defined in: [core/NoopTelemetryFacade.ts:2](https://github.com/RueDeRennes/archi
 #### Type Parameters
 
 | Type Parameter |
-| ------ |
-| `T` |
+| -------------- |
+| `T`            |
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `name` | `string` |
-| `fn` | () => `T` \| `Promise`\<`T`\> |
+| Parameter | Type                          |
+| --------- | ----------------------------- |
+| `name`    | `string`                      |
+| `fn`      | () => `T` \| `Promise`\<`T`\> |
 
 #### Returns
 

package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md

@@ -3,6 +3,7 @@ title: 'Interface: ITelemetryMetricsOptions'
 generated: true
 editUrl: false
 ---
+
 # Interface: ITelemetryMetricsOptions
 
 Defined in: [options/TelemetryOptions.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L9)
@@ -17,7 +18,7 @@ enabled: boolean;
 
 Defined in: [options/TelemetryOptions.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L10)
 
-***
+---
 
 ### exporter?
 
@@ -27,7 +28,7 @@ optional exporter?: "otlp-http" | "console";
 
 Defined in: [options/TelemetryOptions.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L12)
 
-***
+---
 
 ### intervalMs?
 

package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md

@@ -3,6 +3,7 @@ title: 'Interface: ITelemetryOptions'
 generated: true
 editUrl: false
 ---
+
 # Interface: ITelemetryOptions
 
 Defined in: [options/TelemetryOptions.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L15)
@@ -17,7 +18,7 @@ enabled: boolean;
 
 Defined in: [options/TelemetryOptions.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L16)
 
-***
+---
 
 ### environment?
 
@@ -27,7 +28,7 @@ optional environment?: string;
 
 Defined in: [options/TelemetryOptions.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L18)
 
-***
+---
 
 ### instrumentation?
 
@@ -52,7 +53,7 @@ optional express?: boolean;
 optional http?: boolean;
 ```
 
-***
+---
 
 ### interceptor?
 
@@ -70,7 +71,7 @@ Defined in: [options/TelemetryOptions.ts:30](https://github.com/RueDeRennes/arch
 optional operation?: boolean;
 ```
 
-***
+---
 
 ### logCorrelation?
 
@@ -80,7 +81,7 @@ optional logCorrelation?: boolean;
 
 Defined in: [options/TelemetryOptions.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L21)
 
-***
+---
 
 ### metrics?
 
@@ -90,7 +91,7 @@ optional metrics?: ITelemetryMetricsOptions;
 
 Defined in: [options/TelemetryOptions.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L20)
 
-***
+---
 
 ### pattern?
 
@@ -115,7 +116,7 @@ optional enableCacheMetrics?: boolean;
 optional enableOperationMetrics?: boolean;
 ```
 
-***
+---
 
 ### serviceName
 
@@ -125,7 +126,7 @@ serviceName: string;
 
 Defined in: [options/TelemetryOptions.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L17)
 
-***
+---
 
 ### traces?
 

package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md

@@ -3,6 +3,7 @@ title: 'Interface: ITelemetryTracesOptions'
 generated: true
 editUrl: false
 ---
+
 # Interface: ITelemetryTracesOptions
 
 Defined in: [options/TelemetryOptions.ts:3](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L3)
@@ -17,7 +18,7 @@ enabled: boolean;
 
 Defined in: [options/TelemetryOptions.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L4)
 
-***
+---
 
 ### exporter?
 
@@ -27,7 +28,7 @@ optional exporter?: "otlp-http" | "console";
 
 Defined in: [options/TelemetryOptions.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L6)
 
-***
+---
 
 ### samplingRatio?
 

package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md

@@ -3,7 +3,8 @@ title: 'Variable: TELEMETRY\_ENABLED'
 generated: true
 editUrl: false
 ---
-# Variable: TELEMETRY\_ENABLED
+
+# Variable: TELEMETRY_ENABLED
 
 ```ts
 const TELEMETRY_ENABLED: typeof TELEMETRY_ENABLED;

package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md

@@ -3,7 +3,8 @@ title: 'Variable: TELEMETRY\_FACADE'
 generated: true
 editUrl: false
 ---
-# Variable: TELEMETRY\_FACADE
+
+# Variable: TELEMETRY_FACADE
 
 ```ts
 const TELEMETRY_FACADE: typeof TELEMETRY_FACADE;

package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md

@@ -3,7 +3,8 @@ title: 'Variable: TELEMETRY\_OPTIONS'
 generated: true
 editUrl: false
 ---
-# Variable: TELEMETRY\_OPTIONS
+
+# Variable: TELEMETRY_OPTIONS
 
 ```ts
 const TELEMETRY_OPTIONS: typeof TELEMETRY_OPTIONS;

package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md

@@ -3,7 +3,8 @@ title: 'Variable: TELEMETRY\_SHUTDOWN'
 generated: true
 editUrl: false
 ---
-# Variable: TELEMETRY\_SHUTDOWN
+
+# Variable: TELEMETRY_SHUTDOWN
 
 ```ts
 const TELEMETRY_SHUTDOWN: typeof TELEMETRY_SHUTDOWN;

package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md

@@ -3,6 +3,7 @@ title: 'Variable: defaultTelemetryOptions'
 generated: true
 editUrl: false
 ---
+
 # Variable: defaultTelemetryOptions
 
 ```ts

package/data/packages/platform-telemetry/api/index.md

@@ -3,34 +3,35 @@ title: '@breadstone/archipel-platform-telemetry'
 generated: true
 editUrl: false
 ---
+
 # @breadstone/archipel-platform-telemetry
 
 ## Classes
 
-| Class | Description |
-| ------ | ------ |
-| [NoopTelemetryFacade](Class.NoopTelemetryFacade) | - |
+| Class                                                                | Description                                                                                                                        |
+| -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
+| [NoopTelemetryFacade](Class.NoopTelemetryFacade)                     | -                                                                                                                                  |
 | [TelemetryCacheMetricsRecorder](Class.TelemetryCacheMetricsRecorder) | Generic cache metrics recorder that forwards cache lifecycle events into the telemetry facade (which may be a noop when disabled). |
-| [TelemetryFacade](Class.TelemetryFacade) | - |
-| [TelemetryLoggerService](Class.TelemetryLoggerService) | - |
-| [TelemetryModule](Class.TelemetryModule) | - |
-| [TelemetryRuleEngine](Class.TelemetryRuleEngine) | - |
+| [TelemetryFacade](Class.TelemetryFacade)                             | -                                                                                                                                  |
+| [TelemetryLoggerService](Class.TelemetryLoggerService)               | -                                                                                                                                  |
+| [TelemetryModule](Class.TelemetryModule)                             | -                                                                                                                                  |
+| [TelemetryRuleEngine](Class.TelemetryRuleEngine)                     | -                                                                                                                                  |
 
 ## Interfaces
 
-| Interface | Description |
-| ------ | ------ |
-| [ITelemetryFacade](Interface.ITelemetryFacade) | - |
-| [ITelemetryMetricsOptions](Interface.ITelemetryMetricsOptions) | - |
-| [ITelemetryOptions](Interface.ITelemetryOptions) | - |
-| [ITelemetryTracesOptions](Interface.ITelemetryTracesOptions) | - |
+| Interface                                                      | Description |
+| -------------------------------------------------------------- | ----------- |
+| [ITelemetryFacade](Interface.ITelemetryFacade)                 | -           |
+| [ITelemetryMetricsOptions](Interface.ITelemetryMetricsOptions) | -           |
+| [ITelemetryOptions](Interface.ITelemetryOptions)               | -           |
+| [ITelemetryTracesOptions](Interface.ITelemetryTracesOptions)   | -           |
 
 ## Variables
 
-| Variable | Description |
-| ------ | ------ |
-| [defaultTelemetryOptions](Variable.defaultTelemetryOptions) | - |
-| [TELEMETRY\_ENABLED](Variable.TELEMETRY_ENABLED) | - |
-| [TELEMETRY\_FACADE](Variable.TELEMETRY_FACADE) | - |
-| [TELEMETRY\_OPTIONS](Variable.TELEMETRY_OPTIONS) | - |
-| [TELEMETRY\_SHUTDOWN](Variable.TELEMETRY_SHUTDOWN) | - |
+| Variable                                                    | Description |
+| ----------------------------------------------------------- | ----------- |
+| [defaultTelemetryOptions](Variable.defaultTelemetryOptions) | -           |
+| [TELEMETRY_ENABLED](Variable.TELEMETRY_ENABLED)             | -           |
+| [TELEMETRY_FACADE](Variable.TELEMETRY_FACADE)               | -           |
+| [TELEMETRY_OPTIONS](Variable.TELEMETRY_OPTIONS)             | -           |
+| [TELEMETRY_SHUTDOWN](Variable.TELEMETRY_SHUTDOWN)           | -           |