@breadstone/archipel-mcp 0.0.1 → 0.0.2

package/data/packages/index.md

@@ -5,7 +5,7 @@ description: All Archipel platform packages with their primary capabilities.
 
 # Packages
 
-Archipel is organized into 12 independent NestJS modules. Each package can be installed and used on its own — you only pull in what you need.
+Archipel is organized into 13 independent NestJS modules. Each package can be installed and used on its own — you only pull in what you need.
 
 Every package follows the same structure: a dynamic NestJS module with `register()` configuration, abstract ports for contracts you implement, and concrete services you consume.
 
@@ -25,11 +25,12 @@ Every package follows the same structure: a dynamic NestJS module with `register
 
 ## Infrastructure
 
-| Package                                             | Description                                                                                                        |
-| --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
-| [`platform-blob-storage`](./platform-blob-storage/) | Provider-agnostic blob storage with metadata tracking and image variant support.                                   |
-| [`platform-mailing`](./platform-mailing/)           | Multi-strategy email delivery (SMTP, Postmark, Resend, Plunk, Log) with template rendering and verification flows. |
-| [`platform-documents`](./platform-documents/)       | Document generation with pluggable renderers for DOCX, PDF, and image processing.                                  |
+| Package                                             | Description                                                                                                                 |
+| --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
+| [`platform-blob-storage`](./platform-blob-storage/) | Provider-agnostic blob storage with metadata tracking and image variant support.                                            |
+| [`platform-esigning`](./platform-esigning/)         | Provider-agnostic e-signing with support for DocuSign, Adobe Sign, Dropbox Sign, signNow, and a built-in internal provider. |
+| [`platform-mailing`](./platform-mailing/)           | Multi-strategy email delivery (SMTP, Postmark, Resend, Plunk, Log) with template rendering and verification flows.          |
+| [`platform-documents`](./platform-documents/)       | Document generation with pluggable renderers for DOCX, PDF, and image processing.                                           |
 
 ## Operations
 

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

@@ -0,0 +1,141 @@
+---
+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)
+
+Abstract port for analytics and error tracking clients.
+Each provider (Sentry, Application Insights, Datadog) must implement this contract
+so that the consuming application can switch providers without changing business logic.
+
+## Extended by
+
+- [`NoopAnalyticsClient`](Class.NoopAnalyticsClient)
+- [`SentryAnalyticsClient`](Class.SentryAnalyticsClient)
+- [`AppInsightsAnalyticsClient`](Class.AppInsightsAnalyticsClient)
+- [`DatadogAnalyticsClient`](Class.DatadogAnalyticsClient)
+
+## Constructors
+
+### Constructor
+
+```ts
+new AnalyticsClientPort(): AnalyticsClientPort;
+```
+
+#### Returns
+
+`AnalyticsClientPort`
+
+## Methods
+
+### addBreadcrumb()
+
+```ts
+abstract addBreadcrumb(breadcrumb): void;
+```
+
+Defined in: [contracts/AnalyticsClientPort.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/contracts/AnalyticsClientPort.ts#L59)
+
+Add a breadcrumb entry to the analytics trail.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `breadcrumb` | [`IAnalyticsBreadcrumb`](Interface.IAnalyticsBreadcrumb) | The breadcrumb to add. |
+
+#### Returns
+
+`void`
+
+***
+
+### captureException()
+
+```ts
+abstract captureException(error, context?): void;
+```
+
+Defined in: [contracts/AnalyticsClientPort.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/contracts/AnalyticsClientPort.ts#L26)
+
+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`
+
+***
+
+### captureMessage()
+
+```ts
+abstract captureMessage(
+   message, 
+   level, 
+   context?): void;
+```
+
+Defined in: [contracts/AnalyticsClientPort.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/contracts/AnalyticsClientPort.ts#L36)
+
+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`
+
+***
+
+### clearUser()
+
+```ts
+abstract clearUser(): void;
+```
+
+Defined in: [contracts/AnalyticsClientPort.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/contracts/AnalyticsClientPort.ts#L51)
+
+Clear the current user context.
+
+#### Returns
+
+`void`
+
+***
+
+### setUser()
+
+```ts
+abstract setUser(user): void;
+```
+
+Defined in: [contracts/AnalyticsClientPort.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/contracts/AnalyticsClientPort.ts#L44)
+
+Set the current user context for subsequent events.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `user` | [`IAnalyticsUser`](Interface.IAnalyticsUser) | The user context to set. |
+
+#### Returns
+
+`void`

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:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/AppInsightsAnalyticsClient.ts#L21)
+
+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:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/AppInsightsAnalyticsClient.ts#L31)
+
+#### 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:80](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/AppInsightsAnalyticsClient.ts#L80)
+
+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:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/AppInsightsAnalyticsClient.ts#L48)
+
+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:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/AppInsightsAnalyticsClient.ts#L56)
+
+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:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/AppInsightsAnalyticsClient.ts#L74)
+
+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:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/AppInsightsAnalyticsClient.ts#L65)
+
+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:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L20)
+
+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:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L31)
+
+#### 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:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L112)
+
+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:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L48)
+
+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:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L70)
+
+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:107](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L107)
+
+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:88](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L88)
+
+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)