@breadstone/archipel-mcp 0.0.15 → 0.0.16

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

@@ -0,0 +1,47 @@
+---
+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)
+
+NestJS module providing generic analytics and error tracking infrastructure.
+The specific analytics provider (Sentry, Application Insights, Datadog) is selected via the options.
+
+## Constructors
+
+### Constructor
+
+```ts
+new AnalyticsModule(): AnalyticsModule;
+```
+
+#### Returns
+
+`AnalyticsModule`
+
+## Methods
+
+### register()
+
+```ts
+static register(options): DynamicModule;
+```
+
+Defined in: [AnalyticsModule.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/AnalyticsModule.ts#L53)
+
+Configures the module with the specified options.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | [`IAnalyticsModuleOptions`](Interface.IAnalyticsModuleOptions) | The module configuration options. |
+
+#### Returns
+
+`DynamicModule`
+
+Dynamic module definition.

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

@@ -0,0 +1,169 @@
+---
+title: 'Class: AppInsightsAnalyticsClient'
+generated: true
+editUrl: false
+---
+# Class: AppInsightsAnalyticsClient
+
+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.
+
+## Extends
+
+- [`AnalyticsClientPort`](Class.AnalyticsClientPort)
+
+## Constructors
+
+### Constructor
+
+```ts
+new AppInsightsAnalyticsClient(configService): AppInsightsAnalyticsClient;
+```
+
+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 |
+| ------ | ------ |
+| `configService` | `ConfigService` |
+
+#### Returns
+
+`AppInsightsAnalyticsClient`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`constructor`](Class.AnalyticsClientPort#constructor)
+
+## Methods
+
+### addBreadcrumb()
+
+```ts
+addBreadcrumb(breadcrumb): void;
+```
+
+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 |
+| ------ | ------ | ------ |
+| `breadcrumb` | [`IAnalyticsBreadcrumb`](Interface.IAnalyticsBreadcrumb) | The breadcrumb to add. |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`addBreadcrumb`](Class.AnalyticsClientPort#addbreadcrumb)
+
+***
+
+### captureException()
+
+```ts
+captureException(error, context?): void;
+```
+
+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. |
+| `context?` | `Record`\<`string`, `unknown`\> | Optional additional context metadata. |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`captureException`](Class.AnalyticsClientPort#captureexception)
+
+***
+
+### captureMessage()
+
+```ts
+captureMessage(
+   message, 
+   level, 
+   context?): void;
+```
+
+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. |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`captureMessage`](Class.AnalyticsClientPort#capturemessage)
+
+***
+
+### clearUser()
+
+```ts
+clearUser(): void;
+```
+
+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.
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`clearUser`](Class.AnalyticsClientPort#clearuser)
+
+***
+
+### setUser()
+
+```ts
+setUser(user): void;
+```
+
+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. |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`setUser`](Class.AnalyticsClientPort#setuser)

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

@@ -0,0 +1,169 @@
+---
+title: 'Class: DatadogAnalyticsClient'
+generated: true
+editUrl: false
+---
+# Class: DatadogAnalyticsClient
+
+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.
+
+## Extends
+
+- [`AnalyticsClientPort`](Class.AnalyticsClientPort)
+
+## Constructors
+
+### Constructor
+
+```ts
+new DatadogAnalyticsClient(configService): DatadogAnalyticsClient;
+```
+
+Defined in: [datadog/DatadogAnalyticsClient.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L32)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `configService` | `ConfigService` |
+
+#### Returns
+
+`DatadogAnalyticsClient`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`constructor`](Class.AnalyticsClientPort#constructor)
+
+## Methods
+
+### addBreadcrumb()
+
+```ts
+addBreadcrumb(breadcrumb): void;
+```
+
+Defined in: [datadog/DatadogAnalyticsClient.ts:119](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L119)
+
+Add a breadcrumb entry to the analytics trail.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `breadcrumb` | [`IAnalyticsBreadcrumb`](Interface.IAnalyticsBreadcrumb) | The breadcrumb to add. |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`addBreadcrumb`](Class.AnalyticsClientPort#addbreadcrumb)
+
+***
+
+### captureException()
+
+```ts
+captureException(error, context?): void;
+```
+
+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. |
+| `context?` | `Record`\<`string`, `unknown`\> | Optional additional context metadata. |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`captureException`](Class.AnalyticsClientPort#captureexception)
+
+***
+
+### captureMessage()
+
+```ts
+captureMessage(
+   message, 
+   level, 
+   context?): void;
+```
+
+Defined in: [datadog/DatadogAnalyticsClient.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L74)
+
+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. |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`captureMessage`](Class.AnalyticsClientPort#capturemessage)
+
+***
+
+### clearUser()
+
+```ts
+clearUser(): void;
+```
+
+Defined in: [datadog/DatadogAnalyticsClient.ts:114](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L114)
+
+Clear the current user context.
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`clearUser`](Class.AnalyticsClientPort#clearuser)
+
+***
+
+### setUser()
+
+```ts
+setUser(user): void;
+```
+
+Defined in: [datadog/DatadogAnalyticsClient.ts:95](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L95)
+
+Set the current user context for subsequent events.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `user` | [`IAnalyticsUser`](Interface.IAnalyticsUser) | The user context to set. |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`setUser`](Class.AnalyticsClientPort#setuser)

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

@@ -0,0 +1,161 @@
+---
+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)
+
+No-op implementation of the [AnalyticsClientPort](Class.AnalyticsClientPort).
+Suitable for development, testing, or environments where analytics is disabled.
+
+## Extends
+
+- [`AnalyticsClientPort`](Class.AnalyticsClientPort)
+
+## Constructors
+
+### Constructor
+
+```ts
+new NoopAnalyticsClient(): NoopAnalyticsClient;
+```
+
+#### Returns
+
+`NoopAnalyticsClient`
+
+#### Inherited from
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`constructor`](Class.AnalyticsClientPort#constructor)
+
+## Methods
+
+### addBreadcrumb()
+
+```ts
+addBreadcrumb(_breadcrumb): void;
+```
+
+Defined in: [noop/NoopAnalyticsClient.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/noop/NoopAnalyticsClient.ts#L42)
+
+Add a breadcrumb entry to the analytics trail.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `_breadcrumb` | [`IAnalyticsBreadcrumb`](Interface.IAnalyticsBreadcrumb) | The breadcrumb to add. |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`addBreadcrumb`](Class.AnalyticsClientPort#addbreadcrumb)
+
+***
+
+### captureException()
+
+```ts
+captureException(_error, _context?): void;
+```
+
+Defined in: [noop/NoopAnalyticsClient.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/noop/NoopAnalyticsClient.ts#L22)
+
+Capture an exception with optional context.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `_error` | `Error` | The error to capture. |
+| `_context?` | `Record`\<`string`, `unknown`\> | Optional additional context metadata. |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`captureException`](Class.AnalyticsClientPort#captureexception)
+
+***
+
+### captureMessage()
+
+```ts
+captureMessage(
+   _message, 
+   _level, 
+   _context?): void;
+```
+
+Defined in: [noop/NoopAnalyticsClient.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/noop/NoopAnalyticsClient.ts#L27)
+
+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. |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`captureMessage`](Class.AnalyticsClientPort#capturemessage)
+
+***
+
+### clearUser()
+
+```ts
+clearUser(): void;
+```
+
+Defined in: [noop/NoopAnalyticsClient.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/noop/NoopAnalyticsClient.ts#L37)
+
+Clear the current user context.
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`clearUser`](Class.AnalyticsClientPort#clearuser)
+
+***
+
+### setUser()
+
+```ts
+setUser(_user): void;
+```
+
+Defined in: [noop/NoopAnalyticsClient.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/noop/NoopAnalyticsClient.ts#L32)
+
+Set the current user context for subsequent events.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `_user` | [`IAnalyticsUser`](Interface.IAnalyticsUser) | The user context to set. |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`setUser`](Class.AnalyticsClientPort#setuser)

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

@@ -0,0 +1,169 @@
+---
+title: 'Class: SentryAnalyticsClient'
+generated: true
+editUrl: false
+---
+# Class: SentryAnalyticsClient
+
+Defined in: [sentry/SentryAnalyticsClient.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L21)
+
+Sentry implementation of the [AnalyticsClientPort](Class.AnalyticsClientPort).
+Uses the official `@sentry/node` SDK for error tracking and analytics.
+
+## Extends
+
+- [`AnalyticsClientPort`](Class.AnalyticsClientPort)
+
+## Constructors
+
+### Constructor
+
+```ts
+new SentryAnalyticsClient(configService): SentryAnalyticsClient;
+```
+
+Defined in: [sentry/SentryAnalyticsClient.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L30)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `configService` | `ConfigService` |
+
+#### Returns
+
+`SentryAnalyticsClient`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`constructor`](Class.AnalyticsClientPort#constructor)
+
+## Methods
+
+### addBreadcrumb()
+
+```ts
+addBreadcrumb(breadcrumb): void;
+```
+
+Defined in: [sentry/SentryAnalyticsClient.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L74)
+
+Add a breadcrumb entry to the analytics trail.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `breadcrumb` | [`IAnalyticsBreadcrumb`](Interface.IAnalyticsBreadcrumb) | The breadcrumb to add. |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`addBreadcrumb`](Class.AnalyticsClientPort#addbreadcrumb)
+
+***
+
+### captureException()
+
+```ts
+captureException(error, context?): void;
+```
+
+Defined in: [sentry/SentryAnalyticsClient.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L46)
+
+Capture an exception with optional context.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `error` | `Error` | The error to capture. |
+| `context?` | `Record`\<`string`, `unknown`\> | Optional additional context metadata. |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`captureException`](Class.AnalyticsClientPort#captureexception)
+
+***
+
+### captureMessage()
+
+```ts
+captureMessage(
+   message, 
+   level, 
+   context?): void;
+```
+
+Defined in: [sentry/SentryAnalyticsClient.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L51)
+
+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. |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`captureMessage`](Class.AnalyticsClientPort#capturemessage)
+
+***
+
+### clearUser()
+
+```ts
+clearUser(): void;
+```
+
+Defined in: [sentry/SentryAnalyticsClient.ts:69](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L69)
+
+Clear the current user context.
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`clearUser`](Class.AnalyticsClientPort#clearuser)
+
+***
+
+### setUser()
+
+```ts
+setUser(user): void;
+```
+
+Defined in: [sentry/SentryAnalyticsClient.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L59)
+
+Set the current user context for subsequent events.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `user` | [`IAnalyticsUser`](Interface.IAnalyticsUser) | The user context to set. |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`setUser`](Class.AnalyticsClientPort#setuser)