@breadstone/archipel-mcp 0.0.1 → 0.0.3

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

@@ -0,0 +1,162 @@
+---
+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,170 @@
+---
+title: 'Class: SentryAnalyticsClient'
+generated: true
+editUrl: false
+---
+
+# Class: SentryAnalyticsClient
+
+Defined in: [sentry/SentryAnalyticsClient.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L20)
+
+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:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L29)
+
+#### 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:73](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L73)
+
+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:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L45)
+
+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:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L50)
+
+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:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L68)
+
+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:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L58)
+
+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/Interface.IAnalyticsBreadcrumb.md

@@ -0,0 +1,59 @@
+---
+title: 'Interface: IAnalyticsBreadcrumb'
+generated: true
+editUrl: false
+---
+
+# Interface: IAnalyticsBreadcrumb
+
+Defined in: [models/IAnalyticsBreadcrumb.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsBreadcrumb.ts#L6)
+
+Represents a breadcrumb entry for analytics trail.
+
+## Properties
+
+### category
+
+```ts
+readonly category: string;
+```
+
+Defined in: [models/IAnalyticsBreadcrumb.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsBreadcrumb.ts#L10)
+
+Category of the breadcrumb (e.g. `http`, `navigation`, `user`).
+
+---
+
+### data?
+
+```ts
+readonly optional data?: Record<string, unknown>;
+```
+
+Defined in: [models/IAnalyticsBreadcrumb.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsBreadcrumb.ts#L25)
+
+Additional metadata.
+
+---
+
+### level?
+
+```ts
+readonly optional level?: "fatal" | "error" | "warning" | "info" | "debug";
+```
+
+Defined in: [models/IAnalyticsBreadcrumb.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsBreadcrumb.ts#L20)
+
+Severity level.
+
+---
+
+### message
+
+```ts
+readonly message: string;
+```
+
+Defined in: [models/IAnalyticsBreadcrumb.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsBreadcrumb.ts#L15)
+
+Human-readable message.

package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md

@@ -0,0 +1,48 @@
+---
+title: 'Interface: IAnalyticsModuleOptions'
+generated: true
+editUrl: false
+---
+
+# Interface: IAnalyticsModuleOptions
+
+Defined in: [AnalyticsModule.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/AnalyticsModule.ts#L16)
+
+Configuration options for the `AnalyticsModule`.
+
+## Properties
+
+### analyticsClient
+
+```ts
+analyticsClient: Type<AnalyticsClientPort>;
+```
+
+Defined in: [AnalyticsModule.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/AnalyticsModule.ts#L21)
+
+Concrete implementation of the [AnalyticsClientPort](Class.AnalyticsClientPort).
+For example, `SentryAnalyticsClient`, `AppInsightsAnalyticsClient`, `DatadogAnalyticsClient`, or `NoopAnalyticsClient`.
+
+---
+
+### configEntries?
+
+```ts
+optional configEntries?: readonly Omit<IConfigRegistryEntry<unknown>, "module">[];
+```
+
+Defined in: [AnalyticsModule.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/AnalyticsModule.ts#L26)
+
+Provider-specific configuration entries to register with the config module.
+
+---
+
+### isGlobal?
+
+```ts
+optional isGlobal?: boolean;
+```
+
+Defined in: [AnalyticsModule.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/AnalyticsModule.ts#L31)
+
+When `true` the module is registered globally.

package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md

@@ -0,0 +1,59 @@
+---
+title: 'Interface: IAnalyticsUser'
+generated: true
+editUrl: false
+---
+
+# Interface: IAnalyticsUser
+
+Defined in: [models/IAnalyticsUser.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsUser.ts#L6)
+
+Represents user context for analytics tracking.
+
+## Properties
+
+### email?
+
+```ts
+readonly optional email?: string;
+```
+
+Defined in: [models/IAnalyticsUser.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsUser.ts#L15)
+
+Optional e-mail address.
+
+---
+
+### id
+
+```ts
+readonly id: string;
+```
+
+Defined in: [models/IAnalyticsUser.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsUser.ts#L10)
+
+Unique user identifier.
+
+---
+
+### traits?
+
+```ts
+readonly optional traits?: Record<string, unknown>;
+```
+
+Defined in: [models/IAnalyticsUser.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsUser.ts#L25)
+
+Additional user traits.
+
+---
+
+### username?
+
+```ts
+readonly optional username?: string;
+```
+
+Defined in: [models/IAnalyticsUser.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsUser.ts#L20)
+
+Optional display name.

package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md

@@ -0,0 +1,15 @@
+---
+title: 'Type Alias: AnalyticsLevel'
+generated: true
+editUrl: false
+---
+
+# Type Alias: AnalyticsLevel
+
+```ts
+type AnalyticsLevel = 'fatal' | 'error' | 'warning' | 'info' | 'debug';
+```
+
+Defined in: [models/AnalyticsLevel.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/AnalyticsLevel.ts#L6)
+
+Severity level for analytics messages.

package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: APPINSIGHTS\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+
+# Variable: APPINSIGHTS_CONFIG_ENTRIES
+
+```ts
+const APPINSIGHTS_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
+```
+
+Defined in: [application-insights/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/env.ts#L19)
+
+Configuration entries required by the Application Insights analytics provider.

package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: APPLICATIONINSIGHTS\_CONNECTION\_STRING'
+generated: true
+editUrl: false
+---
+
+# Variable: APPLICATIONINSIGHTS_CONNECTION_STRING
+
+```ts
+const APPLICATIONINSIGHTS_CONNECTION_STRING: IConfigKey<string>;
+```
+
+Defined in: [application-insights/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/env.ts#L12)
+
+Application Insights connection string.

package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: DATADOG\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+
+# Variable: DATADOG_CONFIG_ENTRIES
+
+```ts
+const DATADOG_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
+```
+
+Defined in: [datadog/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/env.ts#L22)
+
+Configuration entries required by the Datadog analytics provider.

package/data/packages/platform-analytics/api/Variable.DD_ENV.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: DD\_ENV'
+generated: true
+editUrl: false
+---
+
+# Variable: DD_ENV
+
+```ts
+const DD_ENV: IConfigKey<string>;
+```
+
+Defined in: [datadog/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/env.ts#L15)
+
+Datadog environment identifier (e.g. `production`, `staging`).

package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: DD\_SERVICE'
+generated: true
+editUrl: false
+---
+
+# Variable: DD_SERVICE
+
+```ts
+const DD_SERVICE: IConfigKey<string>;
+```
+
+Defined in: [datadog/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/env.ts#L12)
+
+Datadog service name.

package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: SENTRY\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+
+# Variable: SENTRY_CONFIG_ENTRIES
+
+```ts
+const SENTRY_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
+```
+
+Defined in: [sentry/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/env.ts#L22)
+
+Configuration entries required by the Sentry analytics provider.

package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: SENTRY\_DSN'
+generated: true
+editUrl: false
+---
+
+# Variable: SENTRY_DSN
+
+```ts
+const SENTRY_DSN: IConfigKey<string>;
+```
+
+Defined in: [sentry/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/env.ts#L12)
+
+Sentry DSN for error tracking.

package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: SENTRY\_ENVIRONMENT'
+generated: true
+editUrl: false
+---
+
+# Variable: SENTRY_ENVIRONMENT
+
+```ts
+const SENTRY_ENVIRONMENT: IConfigKey<string>;
+```
+
+Defined in: [sentry/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/env.ts#L15)
+
+Sentry environment identifier (e.g. `production`, `staging`).