@breadstone/archipel-mcp 0.0.13 → 0.0.14

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

@@ -1,226 +0,0 @@
----
-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)
-
-## Extends
-
-- `ConsoleLogger`
-
-## Implements
-
-- `LoggerService`
-
-## Constructors
-
-### Constructor
-
-```ts
-new TelemetryLoggerService(ruleEngine?): TelemetryLoggerService;
-```
-
-Defined in: [logger/TelemetryLoggerService.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/logger/TelemetryLoggerService.ts#L12)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `ruleEngine?` | [`TelemetryRuleEngine`](Class.TelemetryRuleEngine) |
-
-#### Returns
-
-`TelemetryLoggerService`
-
-#### Overrides
-
-```ts
-ConsoleLogger.constructor
-```
-
-## Methods
-
-### debug()
-
-```ts
-debug(message, context?): void;
-```
-
-Defined in: [logger/TelemetryLoggerService.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/logger/TelemetryLoggerService.ts#L19)
-
-Write a 'debug' level log, if the configured level allows for it.
-Prints to `stdout` with newline.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `message` | `string` |
-| `context?` | `string` |
-
-#### Returns
-
-`void`
-
-#### Implementation of
-
-```ts
-LoggerService.debug
-```
-
-#### Overrides
-
-```ts
-ConsoleLogger.debug
-```
-
-***
-
-### error()
-
-```ts
-error(
-   message, 
-   stack?, 
-   context?): void;
-```
-
-Defined in: [logger/TelemetryLoggerService.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/logger/TelemetryLoggerService.ts#L17)
-
-Write an 'error' level log, if the configured level allows for it.
-Prints to `stderr` with newline.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `message` | `string` |
-| `stack?` | `string` |
-| `context?` | `string` |
-
-#### Returns
-
-`void`
-
-#### Implementation of
-
-```ts
-LoggerService.error
-```
-
-#### Overrides
-
-```ts
-ConsoleLogger.error
-```
-
-***
-
-### log()
-
-```ts
-log(message, context?): void;
-```
-
-Defined in: [logger/TelemetryLoggerService.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/logger/TelemetryLoggerService.ts#L16)
-
-Write a 'log' level log, if the configured level allows for it.
-Prints to `stdout` with newline.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `message` | `string` |
-| `context?` | `string` |
-
-#### Returns
-
-`void`
-
-#### Implementation of
-
-```ts
-LoggerService.log
-```
-
-#### Overrides
-
-```ts
-ConsoleLogger.log
-```
-
-***
-
-### verbose()
-
-```ts
-verbose(message, context?): void;
-```
-
-Defined in: [logger/TelemetryLoggerService.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/logger/TelemetryLoggerService.ts#L20)
-
-Write a 'verbose' level log, if the configured level allows for it.
-Prints to `stdout` with newline.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `message` | `string` |
-| `context?` | `string` |
-
-#### Returns
-
-`void`
-
-#### Implementation of
-
-```ts
-LoggerService.verbose
-```
-
-#### Overrides
-
-```ts
-ConsoleLogger.verbose
-```
-
-***
-
-### warn()
-
-```ts
-warn(message, context?): void;
-```
-
-Defined in: [logger/TelemetryLoggerService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/logger/TelemetryLoggerService.ts#L18)
-
-Write a 'warn' level log, if the configured level allows for it.
-Prints to `stdout` with newline.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `message` | `string` |
-| `context?` | `string` |
-
-#### Returns
-
-`void`
-
-#### Implementation of
-
-```ts
-LoggerService.warn
-```
-
-#### Overrides
-
-```ts
-ConsoleLogger.warn
-```

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

@@ -1,40 +0,0 @@
----
-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)
-
-## Constructors
-
-### Constructor
-
-```ts
-new TelemetryModule(): TelemetryModule;
-```
-
-#### Returns
-
-`TelemetryModule`
-
-## Methods
-
-### register()
-
-```ts
-static register(options): DynamicModule;
-```
-
-Defined in: [TelemetryModule.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/TelemetryModule.ts#L17)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `options` | `Partial`\<[`ITelemetryOptions`](Interface.ITelemetryOptions)\> |
-
-#### Returns
-
-`DynamicModule`

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

@@ -1,48 +0,0 @@
----
-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)
-
-## Constructors
-
-### Constructor
-
-```ts
-new TelemetryRuleEngine(options): TelemetryRuleEngine;
-```
-
-Defined in: [rules/TelemetryRuleEngine.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/rules/TelemetryRuleEngine.ts#L14)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `options` | [`ITelemetryOptions`](Interface.ITelemetryOptions) |
-
-#### Returns
-
-`TelemetryRuleEngine`
-
-## Methods
-
-### process()
-
-```ts
-process(message): void;
-```
-
-Defined in: [rules/TelemetryRuleEngine.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/rules/TelemetryRuleEngine.ts#L18)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `message` | `string` |
-
-#### Returns
-
-`void`

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

@@ -1,85 +0,0 @@
----
-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)
-
-## Methods
-
-### recordCacheEvent()?
-
-```ts
-optional recordCacheEvent(event): void;
-```
-
-Defined in: [core/NoopTelemetryFacade.ts:3](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/core/NoopTelemetryFacade.ts#L3)
-
-#### Parameters
-
-| 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, 
-   labels?): void;
-```
-
-Defined in: [core/NoopTelemetryFacade.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/core/NoopTelemetryFacade.ts#L4)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `name` | `string` |
-| `type` | `string` |
-| `value` | `number` |
-| `labels?` | `Record`\<`string`, `string`\> |
-
-#### Returns
-
-`void`
-
-***
-
-### runOperation()
-
-```ts
-runOperation<T>(name, fn): Promise<T>;
-```
-
-Defined in: [core/NoopTelemetryFacade.ts:2](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/core/NoopTelemetryFacade.ts#L2)
-
-#### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `T` |
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `name` | `string` |
-| `fn` | () => `T` \| `Promise`\<`T`\> |
-
-#### Returns
-
-`Promise`\<`T`\>

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

@@ -1,38 +0,0 @@
----
-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)
-
-## Properties
-
-### enabled
-
-```ts
-enabled: boolean;
-```
-
-Defined in: [options/TelemetryOptions.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L10)
-
-***
-
-### exporter?
-
-```ts
-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?
-
-```ts
-optional intervalMs?: number;
-```
-
-Defined in: [options/TelemetryOptions.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L11)

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

@@ -1,136 +0,0 @@
----
-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)
-
-## Properties
-
-### enabled
-
-```ts
-enabled: boolean;
-```
-
-Defined in: [options/TelemetryOptions.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L16)
-
-***
-
-### environment?
-
-```ts
-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?
-
-```ts
-optional instrumentation?: {
-  express?: boolean;
-  http?: boolean;
-};
-```
-
-Defined in: [options/TelemetryOptions.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L22)
-
-#### express?
-
-```ts
-optional express?: boolean;
-```
-
-#### http?
-
-```ts
-optional http?: boolean;
-```
-
-***
-
-### interceptor?
-
-```ts
-optional interceptor?: {
-  operation?: boolean;
-};
-```
-
-Defined in: [options/TelemetryOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L30)
-
-#### operation?
-
-```ts
-optional operation?: boolean;
-```
-
-***
-
-### logCorrelation?
-
-```ts
-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?
-
-```ts
-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?
-
-```ts
-optional pattern?: {
-  enableCacheMetrics?: boolean;
-  enableOperationMetrics?: boolean;
-};
-```
-
-Defined in: [options/TelemetryOptions.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L26)
-
-#### enableCacheMetrics?
-
-```ts
-optional enableCacheMetrics?: boolean;
-```
-
-#### enableOperationMetrics?
-
-```ts
-optional enableOperationMetrics?: boolean;
-```
-
-***
-
-### serviceName
-
-```ts
-serviceName: string;
-```
-
-Defined in: [options/TelemetryOptions.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L17)
-
-***
-
-### traces?
-
-```ts
-optional traces?: ITelemetryTracesOptions;
-```
-
-Defined in: [options/TelemetryOptions.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L19)

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

@@ -1,38 +0,0 @@
----
-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)
-
-## Properties
-
-### enabled
-
-```ts
-enabled: boolean;
-```
-
-Defined in: [options/TelemetryOptions.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L4)
-
-***
-
-### exporter?
-
-```ts
-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?
-
-```ts
-optional samplingRatio?: number;
-```
-
-Defined in: [options/TelemetryOptions.ts:5](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L5)

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

@@ -1,12 +0,0 @@
----
-title: 'Variable: TELEMETRY\_ENABLED'
-generated: true
-editUrl: false
----
-# Variable: TELEMETRY\_ENABLED
-
-```ts
-const TELEMETRY_ENABLED: typeof TELEMETRY_ENABLED;
-```
-
-Defined in: [tokens.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/tokens.ts#L4)

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

@@ -1,12 +0,0 @@
----
-title: 'Variable: TELEMETRY\_FACADE'
-generated: true
-editUrl: false
----
-# Variable: TELEMETRY\_FACADE
-
-```ts
-const TELEMETRY_FACADE: typeof TELEMETRY_FACADE;
-```
-
-Defined in: [tokens.ts:3](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/tokens.ts#L3)

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

@@ -1,12 +0,0 @@
----
-title: 'Variable: TELEMETRY\_OPTIONS'
-generated: true
-editUrl: false
----
-# Variable: TELEMETRY\_OPTIONS
-
-```ts
-const TELEMETRY_OPTIONS: typeof TELEMETRY_OPTIONS;
-```
-
-Defined in: [tokens.ts:2](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/tokens.ts#L2)

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

@@ -1,12 +0,0 @@
----
-title: 'Variable: TELEMETRY\_SHUTDOWN'
-generated: true
-editUrl: false
----
-# Variable: TELEMETRY\_SHUTDOWN
-
-```ts
-const TELEMETRY_SHUTDOWN: typeof TELEMETRY_SHUTDOWN;
-```
-
-Defined in: [tokens.ts:5](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/tokens.ts#L5)

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

@@ -1,12 +0,0 @@
----
-title: 'Variable: defaultTelemetryOptions'
-generated: true
-editUrl: false
----
-# Variable: defaultTelemetryOptions
-
-```ts
-const defaultTelemetryOptions: ITelemetryOptions;
-```
-
-Defined in: [options/TelemetryOptions.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/options/TelemetryOptions.ts#L35)