@breadstone/archipel-mcp 0.0.8 → 0.0.10

package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md

@@ -3,7 +3,6 @@ title: 'Abstract Class: AnalyticsClientPort'
 generated: true
 editUrl: false
 ---
-
 # Abstract Class: AnalyticsClientPort
 
 Defined in: [contracts/AnalyticsClientPort.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/contracts/AnalyticsClientPort.ts#L16)
@@ -45,15 +44,15 @@ Add a breadcrumb entry to the analytics trail.
 
 #### Parameters
 
-| Parameter    | Type                                                     | Description            |
-| ------------ | -------------------------------------------------------- | ---------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `breadcrumb` | [`IAnalyticsBreadcrumb`](Interface.IAnalyticsBreadcrumb) | The breadcrumb to add. |
 
 #### Returns
 
 `void`
 
----
+***
 
 ### captureException()
 
@@ -67,23 +66,23 @@ Capture an exception with optional context.
 
 #### Parameters
 
-| Parameter  | Type                            | Description                           |
-| ---------- | ------------------------------- | ------------------------------------- |
-| `error`    | `Error`                         | The error to capture.                 |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `error` | `Error` | The error to capture. |
 | `context?` | `Record`\<`string`, `unknown`\> | Optional additional context metadata. |
 
 #### Returns
 
 `void`
 
----
+***
 
 ### captureMessage()
 
 ```ts
 abstract captureMessage(
-   message,
-   level,
+   message, 
+   level, 
    context?): void;
 ```
 
@@ -93,17 +92,17 @@ Capture a message with a specific severity level.
 
 #### Parameters
 
-| Parameter  | Type                                         | Description                           |
-| ---------- | -------------------------------------------- | ------------------------------------- |
-| `message`  | `string`                                     | The message to capture.               |
-| `level`    | [`AnalyticsLevel`](TypeAlias.AnalyticsLevel) | Severity level of the message.        |
-| `context?` | `Record`\<`string`, `unknown`\>              | Optional additional context metadata. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `message` | `string` | The message to capture. |
+| `level` | [`AnalyticsLevel`](TypeAlias.AnalyticsLevel) | Severity level of the message. |
+| `context?` | `Record`\<`string`, `unknown`\> | Optional additional context metadata. |
 
 #### Returns
 
 `void`
 
----
+***
 
 ### clearUser()
 
@@ -119,7 +118,7 @@ Clear the current user context.
 
 `void`
 
----
+***
 
 ### setUser()
 
@@ -133,9 +132,9 @@ Set the current user context for subsequent events.
 
 #### Parameters
 
-| Parameter | Type                                         | Description              |
-| --------- | -------------------------------------------- | ------------------------ |
-| `user`    | [`IAnalyticsUser`](Interface.IAnalyticsUser) | The user context to set. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `user` | [`IAnalyticsUser`](Interface.IAnalyticsUser) | The user context to set. |
 
 #### Returns
 

package/data/packages/platform-analytics/api/Class.AnalyticsModule.md

@@ -3,7 +3,6 @@ title: 'Class: AnalyticsModule'
 generated: true
 editUrl: false
 ---
-
 # Class: AnalyticsModule
 
 Defined in: [AnalyticsModule.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/AnalyticsModule.ts#L43)
@@ -37,8 +36,8 @@ Configures the module with the specified options.
 
 #### Parameters
 
-| Parameter | Type                                                           | Description                       |
-| --------- | -------------------------------------------------------------- | --------------------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `options` | [`IAnalyticsModuleOptions`](Interface.IAnalyticsModuleOptions) | The module configuration options. |
 
 #### Returns

package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md

@@ -3,10 +3,9 @@ title: 'Class: AppInsightsAnalyticsClient'
 generated: true
 editUrl: false
 ---
-
 # Class: AppInsightsAnalyticsClient
 
-Defined in: [application-insights/AppInsightsAnalyticsClient.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/AppInsightsAnalyticsClient.ts#L21)
+Defined in: [application-insights/AppInsightsAnalyticsClient.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/AppInsightsAnalyticsClient.ts#L22)
 
 Azure Application Insights implementation of the [AnalyticsClientPort](Class.AnalyticsClientPort).
 Uses the `applicationinsights` SDK for error tracking and analytics.
@@ -23,12 +22,12 @@ Uses the `applicationinsights` SDK for error tracking and analytics.
 new AppInsightsAnalyticsClient(configService): AppInsightsAnalyticsClient;
 ```
 
-Defined in: [application-insights/AppInsightsAnalyticsClient.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/AppInsightsAnalyticsClient.ts#L31)
+Defined in: [application-insights/AppInsightsAnalyticsClient.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/AppInsightsAnalyticsClient.ts#L32)
 
 #### Parameters
 
-| Parameter       | Type            |
-| --------------- | --------------- |
+| Parameter | Type |
+| ------ | ------ |
 | `configService` | `ConfigService` |
 
 #### Returns
@@ -47,14 +46,14 @@ Defined in: [application-insights/AppInsightsAnalyticsClient.ts:31](https://gith
 addBreadcrumb(breadcrumb): void;
 ```
 
-Defined in: [application-insights/AppInsightsAnalyticsClient.ts:80](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/AppInsightsAnalyticsClient.ts#L80)
+Defined in: [application-insights/AppInsightsAnalyticsClient.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/AppInsightsAnalyticsClient.ts#L81)
 
 Add a breadcrumb entry to the analytics trail.
 
 #### Parameters
 
-| Parameter    | Type                                                     | Description            |
-| ------------ | -------------------------------------------------------- | ---------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `breadcrumb` | [`IAnalyticsBreadcrumb`](Interface.IAnalyticsBreadcrumb) | The breadcrumb to add. |
 
 #### Returns
@@ -65,7 +64,7 @@ Add a breadcrumb entry to the analytics trail.
 
 [`AnalyticsClientPort`](Class.AnalyticsClientPort).[`addBreadcrumb`](Class.AnalyticsClientPort#addbreadcrumb)
 
----
+***
 
 ### captureException()
 
@@ -73,15 +72,15 @@ Add a breadcrumb entry to the analytics trail.
 captureException(error, context?): void;
 ```
 
-Defined in: [application-insights/AppInsightsAnalyticsClient.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/AppInsightsAnalyticsClient.ts#L48)
+Defined in: [application-insights/AppInsightsAnalyticsClient.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/AppInsightsAnalyticsClient.ts#L49)
 
 Capture an exception with optional context.
 
 #### Parameters
 
-| Parameter  | Type                            | Description                           |
-| ---------- | ------------------------------- | ------------------------------------- |
-| `error`    | `Error`                         | The error to capture.                 |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `error` | `Error` | The error to capture. |
 | `context?` | `Record`\<`string`, `unknown`\> | Optional additional context metadata. |
 
 #### Returns
@@ -92,28 +91,28 @@ Capture an exception with optional context.
 
 [`AnalyticsClientPort`](Class.AnalyticsClientPort).[`captureException`](Class.AnalyticsClientPort#captureexception)
 
----
+***
 
 ### captureMessage()
 
 ```ts
 captureMessage(
-   message,
-   level,
+   message, 
+   level, 
    context?): void;
 ```
 
-Defined in: [application-insights/AppInsightsAnalyticsClient.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/AppInsightsAnalyticsClient.ts#L56)
+Defined in: [application-insights/AppInsightsAnalyticsClient.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/AppInsightsAnalyticsClient.ts#L57)
 
 Capture a message with a specific severity level.
 
 #### Parameters
 
-| Parameter  | Type                                         | Description                           |
-| ---------- | -------------------------------------------- | ------------------------------------- |
-| `message`  | `string`                                     | The message to capture.               |
-| `level`    | [`AnalyticsLevel`](TypeAlias.AnalyticsLevel) | Severity level of the message.        |
-| `context?` | `Record`\<`string`, `unknown`\>              | Optional additional context metadata. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `message` | `string` | The message to capture. |
+| `level` | [`AnalyticsLevel`](TypeAlias.AnalyticsLevel) | Severity level of the message. |
+| `context?` | `Record`\<`string`, `unknown`\> | Optional additional context metadata. |
 
 #### Returns
 
@@ -123,7 +122,7 @@ Capture a message with a specific severity level.
 
 [`AnalyticsClientPort`](Class.AnalyticsClientPort).[`captureMessage`](Class.AnalyticsClientPort#capturemessage)
 
----
+***
 
 ### clearUser()
 
@@ -131,7 +130,7 @@ Capture a message with a specific severity level.
 clearUser(): void;
 ```
 
-Defined in: [application-insights/AppInsightsAnalyticsClient.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/AppInsightsAnalyticsClient.ts#L74)
+Defined in: [application-insights/AppInsightsAnalyticsClient.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/AppInsightsAnalyticsClient.ts#L75)
 
 Clear the current user context.
 
@@ -143,7 +142,7 @@ Clear the current user context.
 
 [`AnalyticsClientPort`](Class.AnalyticsClientPort).[`clearUser`](Class.AnalyticsClientPort#clearuser)
 
----
+***
 
 ### setUser()
 
@@ -151,15 +150,15 @@ Clear the current user context.
 setUser(user): void;
 ```
 
-Defined in: [application-insights/AppInsightsAnalyticsClient.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/AppInsightsAnalyticsClient.ts#L65)
+Defined in: [application-insights/AppInsightsAnalyticsClient.ts:66](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/AppInsightsAnalyticsClient.ts#L66)
 
 Set the current user context for subsequent events.
 
 #### Parameters
 
-| Parameter | Type                                         | Description              |
-| --------- | -------------------------------------------- | ------------------------ |
-| `user`    | [`IAnalyticsUser`](Interface.IAnalyticsUser) | The user context to set. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `user` | [`IAnalyticsUser`](Interface.IAnalyticsUser) | The user context to set. |
 
 #### Returns
 

package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md

@@ -3,10 +3,9 @@ title: 'Class: DatadogAnalyticsClient'
 generated: true
 editUrl: false
 ---
-
 # Class: DatadogAnalyticsClient
 
-Defined in: [datadog/DatadogAnalyticsClient.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L20)
+Defined in: [datadog/DatadogAnalyticsClient.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L21)
 
 Datadog implementation of the [AnalyticsClientPort](Class.AnalyticsClientPort).
 Uses the `dd-trace` SDK for error tracking and analytics.
@@ -23,12 +22,12 @@ Uses the `dd-trace` SDK for error tracking and analytics.
 new DatadogAnalyticsClient(configService): DatadogAnalyticsClient;
 ```
 
-Defined in: [datadog/DatadogAnalyticsClient.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L31)
+Defined in: [datadog/DatadogAnalyticsClient.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L32)
 
 #### Parameters
 
-| Parameter       | Type            |
-| --------------- | --------------- |
+| Parameter | Type |
+| ------ | ------ |
 | `configService` | `ConfigService` |
 
 #### Returns
@@ -47,14 +46,14 @@ Defined in: [datadog/DatadogAnalyticsClient.ts:31](https://github.com/RueDeRenne
 addBreadcrumb(breadcrumb): void;
 ```
 
-Defined in: [datadog/DatadogAnalyticsClient.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L112)
+Defined in: [datadog/DatadogAnalyticsClient.ts:113](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L113)
 
 Add a breadcrumb entry to the analytics trail.
 
 #### Parameters
 
-| Parameter    | Type                                                     | Description            |
-| ------------ | -------------------------------------------------------- | ---------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `breadcrumb` | [`IAnalyticsBreadcrumb`](Interface.IAnalyticsBreadcrumb) | The breadcrumb to add. |
 
 #### Returns
@@ -65,7 +64,7 @@ Add a breadcrumb entry to the analytics trail.
 
 [`AnalyticsClientPort`](Class.AnalyticsClientPort).[`addBreadcrumb`](Class.AnalyticsClientPort#addbreadcrumb)
 
----
+***
 
 ### captureException()
 
@@ -73,15 +72,15 @@ Add a breadcrumb entry to the analytics trail.
 captureException(error, context?): void;
 ```
 
-Defined in: [datadog/DatadogAnalyticsClient.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L48)
+Defined in: [datadog/DatadogAnalyticsClient.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L49)
 
 Capture an exception with optional context.
 
 #### Parameters
 
-| Parameter  | Type                            | Description                           |
-| ---------- | ------------------------------- | ------------------------------------- |
-| `error`    | `Error`                         | The error to capture.                 |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `error` | `Error` | The error to capture. |
 | `context?` | `Record`\<`string`, `unknown`\> | Optional additional context metadata. |
 
 #### Returns
@@ -92,28 +91,28 @@ Capture an exception with optional context.
 
 [`AnalyticsClientPort`](Class.AnalyticsClientPort).[`captureException`](Class.AnalyticsClientPort#captureexception)
 
----
+***
 
 ### captureMessage()
 
 ```ts
 captureMessage(
-   message,
-   level,
+   message, 
+   level, 
    context?): void;
 ```
 
-Defined in: [datadog/DatadogAnalyticsClient.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L70)
+Defined in: [datadog/DatadogAnalyticsClient.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L71)
 
 Capture a message with a specific severity level.
 
 #### Parameters
 
-| Parameter  | Type                                         | Description                           |
-| ---------- | -------------------------------------------- | ------------------------------------- |
-| `message`  | `string`                                     | The message to capture.               |
-| `level`    | [`AnalyticsLevel`](TypeAlias.AnalyticsLevel) | Severity level of the message.        |
-| `context?` | `Record`\<`string`, `unknown`\>              | Optional additional context metadata. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `message` | `string` | The message to capture. |
+| `level` | [`AnalyticsLevel`](TypeAlias.AnalyticsLevel) | Severity level of the message. |
+| `context?` | `Record`\<`string`, `unknown`\> | Optional additional context metadata. |
 
 #### Returns
 
@@ -123,7 +122,7 @@ Capture a message with a specific severity level.
 
 [`AnalyticsClientPort`](Class.AnalyticsClientPort).[`captureMessage`](Class.AnalyticsClientPort#capturemessage)
 
----
+***
 
 ### clearUser()
 
@@ -131,7 +130,7 @@ Capture a message with a specific severity level.
 clearUser(): void;
 ```
 
-Defined in: [datadog/DatadogAnalyticsClient.ts:107](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L107)
+Defined in: [datadog/DatadogAnalyticsClient.ts:108](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L108)
 
 Clear the current user context.
 
@@ -143,7 +142,7 @@ Clear the current user context.
 
 [`AnalyticsClientPort`](Class.AnalyticsClientPort).[`clearUser`](Class.AnalyticsClientPort#clearuser)
 
----
+***
 
 ### setUser()
 
@@ -151,15 +150,15 @@ Clear the current user context.
 setUser(user): void;
 ```
 
-Defined in: [datadog/DatadogAnalyticsClient.ts:88](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L88)
+Defined in: [datadog/DatadogAnalyticsClient.ts:89](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L89)
 
 Set the current user context for subsequent events.
 
 #### Parameters
 
-| Parameter | Type                                         | Description              |
-| --------- | -------------------------------------------- | ------------------------ |
-| `user`    | [`IAnalyticsUser`](Interface.IAnalyticsUser) | The user context to set. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `user` | [`IAnalyticsUser`](Interface.IAnalyticsUser) | The user context to set. |
 
 #### Returns
 

package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md

@@ -3,7 +3,6 @@ title: 'Class: NoopAnalyticsClient'
 generated: true
 editUrl: false
 ---
-
 # Class: NoopAnalyticsClient
 
 Defined in: [noop/NoopAnalyticsClient.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/noop/NoopAnalyticsClient.ts#L18)
@@ -45,8 +44,8 @@ Add a breadcrumb entry to the analytics trail.
 
 #### Parameters
 
-| Parameter     | Type                                                     | Description            |
-| ------------- | -------------------------------------------------------- | ---------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `_breadcrumb` | [`IAnalyticsBreadcrumb`](Interface.IAnalyticsBreadcrumb) | The breadcrumb to add. |
 
 #### Returns
@@ -57,7 +56,7 @@ Add a breadcrumb entry to the analytics trail.
 
 [`AnalyticsClientPort`](Class.AnalyticsClientPort).[`addBreadcrumb`](Class.AnalyticsClientPort#addbreadcrumb)
 
----
+***
 
 ### captureException()
 
@@ -71,9 +70,9 @@ Capture an exception with optional context.
 
 #### Parameters
 
-| Parameter   | Type                            | Description                           |
-| ----------- | ------------------------------- | ------------------------------------- |
-| `_error`    | `Error`                         | The error to capture.                 |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `_error` | `Error` | The error to capture. |
 | `_context?` | `Record`\<`string`, `unknown`\> | Optional additional context metadata. |
 
 #### Returns
@@ -84,14 +83,14 @@ Capture an exception with optional context.
 
 [`AnalyticsClientPort`](Class.AnalyticsClientPort).[`captureException`](Class.AnalyticsClientPort#captureexception)
 
----
+***
 
 ### captureMessage()
 
 ```ts
 captureMessage(
-   _message,
-   _level,
+   _message, 
+   _level, 
    _context?): void;
 ```
 
@@ -101,11 +100,11 @@ Capture a message with a specific severity level.
 
 #### Parameters
 
-| Parameter   | Type                                         | Description                           |
-| ----------- | -------------------------------------------- | ------------------------------------- |
-| `_message`  | `string`                                     | The message to capture.               |
-| `_level`    | [`AnalyticsLevel`](TypeAlias.AnalyticsLevel) | Severity level of the message.        |
-| `_context?` | `Record`\<`string`, `unknown`\>              | Optional additional context metadata. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `_message` | `string` | The message to capture. |
+| `_level` | [`AnalyticsLevel`](TypeAlias.AnalyticsLevel) | Severity level of the message. |
+| `_context?` | `Record`\<`string`, `unknown`\> | Optional additional context metadata. |
 
 #### Returns
 
@@ -115,7 +114,7 @@ Capture a message with a specific severity level.
 
 [`AnalyticsClientPort`](Class.AnalyticsClientPort).[`captureMessage`](Class.AnalyticsClientPort#capturemessage)
 
----
+***
 
 ### clearUser()
 
@@ -135,7 +134,7 @@ Clear the current user context.
 
 [`AnalyticsClientPort`](Class.AnalyticsClientPort).[`clearUser`](Class.AnalyticsClientPort#clearuser)
 
----
+***
 
 ### setUser()
 
@@ -149,9 +148,9 @@ Set the current user context for subsequent events.
 
 #### Parameters
 
-| Parameter | Type                                         | Description              |
-| --------- | -------------------------------------------- | ------------------------ |
-| `_user`   | [`IAnalyticsUser`](Interface.IAnalyticsUser) | The user context to set. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `_user` | [`IAnalyticsUser`](Interface.IAnalyticsUser) | The user context to set. |
 
 #### Returns