@breadstone/archipel-mcp 0.0.19 → 0.0.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. package/data/guides/ai-text-generation.md +10 -0
  2. package/data/guides/analytics-and-error-tracking.md +6 -0
  3. package/data/guides/cryptography-and-otp.md +18 -0
  4. package/data/guides/document-generation.md +26 -0
  5. package/data/guides/email-delivery.md +23 -0
  6. package/data/guides/email-templates.md +298 -0
  7. package/data/guides/esigning-integration.md +1 -1
  8. package/data/guides/index.md +1 -0
  9. package/data/guides/mcp-server.md +9 -0
  10. package/data/guides/payments-and-feature-gating.md +18 -0
  11. package/data/guides/telemetry-and-observability.md +7 -1
  12. package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +55 -6
  13. package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +32 -6
  14. package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +55 -6
  15. package/data/packages/platform-analytics/index.md +13 -0
  16. package/data/packages/platform-core/api/Class.EventHub.md +7 -7
  17. package/data/packages/platform-core/api/Class.HealthOrchestrator.md +1 -1
  18. package/data/packages/platform-core/api/Class.SseHub.md +29 -6
  19. package/data/packages/platform-core/index.md +2 -1
  20. package/data/packages/platform-cryptography/api/Class.CryptoService.md +3 -3
  21. package/data/packages/platform-cryptography/index.md +10 -0
  22. package/data/packages/platform-documents/api/Class.DocumentEngine.md +4 -4
  23. package/data/packages/platform-documents/api/Class.DocumentError.md +61 -0
  24. package/data/packages/platform-documents/api/Class.DocumentRenderError.md +53 -0
  25. package/data/packages/platform-documents/api/Class.DocumentValidationError.md +52 -0
  26. package/data/packages/platform-documents/api/Class.ImageProcessingError.md +53 -0
  27. package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +5 -5
  28. package/data/packages/platform-documents/api/index.md +4 -0
  29. package/data/packages/platform-documents/index.md +27 -0
  30. package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +8 -8
  31. package/data/packages/platform-esigning/index.md +2 -0
  32. package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +3 -3
  33. package/data/packages/platform-intelligence/api/Class.IntelligenceConfigurationError.md +50 -0
  34. package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +27 -4
  35. package/data/packages/platform-intelligence/api/Class.IntelligenceValidationError.md +50 -0
  36. package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +1 -1
  37. package/data/packages/platform-intelligence/api/index.md +2 -0
  38. package/data/packages/platform-intelligence/index.md +32 -0
  39. package/data/packages/platform-logging/api/Class.LoggerModule.md +1 -1
  40. package/data/packages/platform-logging/index.md +2 -0
  41. package/data/packages/platform-mailing/api/Class.MailDeliveryError.md +65 -0
  42. package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +3 -3
  43. package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +3 -3
  44. package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +3 -3
  45. package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +3 -3
  46. package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +3 -3
  47. package/data/packages/platform-mailing/api/index.md +1 -0
  48. package/data/packages/platform-mailing/index.md +29 -0
  49. package/data/packages/platform-mcp/api/Class.McpServerService.md +8 -8
  50. package/data/packages/platform-mcp/index.md +11 -0
  51. package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +2 -2
  52. package/data/packages/platform-openapi/index.md +1 -1
  53. package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +6 -6
  54. package/data/packages/platform-payments/api/Class.MollieClient.md +6 -6
  55. package/data/packages/platform-payments/api/Class.PaddleClient.md +6 -6
  56. package/data/packages/platform-payments/api/Class.PaymentError.md +65 -0
  57. package/data/packages/platform-payments/api/Class.StripeClient.md +6 -6
  58. package/data/packages/platform-payments/api/index.md +1 -0
  59. package/data/packages/platform-payments/index.md +29 -0
  60. package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +1 -1
  61. package/data/packages/platform-reporting/index.md +3 -1
  62. package/data/packages/platform-telemetry/api/Class.MetricsService.md +29 -3
  63. package/data/packages/platform-telemetry/api/Class.OtelSdkHolder.md +3 -2
  64. package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +6 -6
  65. package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +3 -3
  66. package/data/packages/platform-telemetry/api/index.md +1 -1
  67. package/data/packages/platform-telemetry/index.md +3 -1
  68. package/package.json +1 -1
@@ -14,6 +14,10 @@ Uses the `dd-trace` SDK for error tracking and analytics.
14
14
 
15
15
  - [`AnalyticsClientPort`](Class.AnalyticsClientPort)
16
16
 
17
+ ## Implements
18
+
19
+ - `OnModuleInit`
20
+
17
21
  ## Constructors
18
22
 
19
23
  ### Constructor
@@ -22,7 +26,7 @@ Uses the `dd-trace` SDK for error tracking and analytics.
22
26
  new DatadogAnalyticsClient(configService): DatadogAnalyticsClient;
23
27
  ```
24
28
 
25
- Defined in: [datadog/DatadogAnalyticsClient.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L32)
29
+ Defined in: [datadog/DatadogAnalyticsClient.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L33)
26
30
 
27
31
  #### Parameters
28
32
 
@@ -46,7 +50,7 @@ Defined in: [datadog/DatadogAnalyticsClient.ts:32](https://github.com/RueDeRenne
46
50
  addBreadcrumb(breadcrumb): void;
47
51
  ```
48
52
 
49
- Defined in: [datadog/DatadogAnalyticsClient.ts:119](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L119)
53
+ Defined in: [datadog/DatadogAnalyticsClient.ts:129](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L129)
50
54
 
51
55
  Add a breadcrumb entry to the analytics trail.
52
56
 
@@ -72,7 +76,7 @@ Add a breadcrumb entry to the analytics trail.
72
76
  captureException(error, context?): void;
73
77
  ```
74
78
 
75
- Defined in: [datadog/DatadogAnalyticsClient.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L49)
79
+ Defined in: [datadog/DatadogAnalyticsClient.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L59)
76
80
 
77
81
  Capture an exception with optional context.
78
82
 
@@ -102,7 +106,7 @@ captureMessage(
102
106
  context?): void;
103
107
  ```
104
108
 
105
- Defined in: [datadog/DatadogAnalyticsClient.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L74)
109
+ Defined in: [datadog/DatadogAnalyticsClient.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L84)
106
110
 
107
111
  Capture a message with a specific severity level.
108
112
 
@@ -130,7 +134,7 @@ Capture a message with a specific severity level.
130
134
  clearUser(): void;
131
135
  ```
132
136
 
133
- Defined in: [datadog/DatadogAnalyticsClient.ts:114](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L114)
137
+ Defined in: [datadog/DatadogAnalyticsClient.ts:124](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L124)
134
138
 
135
139
  Clear the current user context.
136
140
 
@@ -144,13 +148,35 @@ Clear the current user context.
144
148
 
145
149
  ***
146
150
 
151
+ ### onModuleInit()
152
+
153
+ ```ts
154
+ onModuleInit(): void;
155
+ ```
156
+
157
+ Defined in: [datadog/DatadogAnalyticsClient.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L49)
158
+
159
+ Initializes the Datadog tracer SDK.
160
+
161
+ #### Returns
162
+
163
+ `void`
164
+
165
+ #### Implementation of
166
+
167
+ ```ts
168
+ OnModuleInit.onModuleInit
169
+ ```
170
+
171
+ ***
172
+
147
173
  ### setUser()
148
174
 
149
175
  ```ts
150
176
  setUser(user): void;
151
177
  ```
152
178
 
153
- Defined in: [datadog/DatadogAnalyticsClient.ts:95](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L95)
179
+ Defined in: [datadog/DatadogAnalyticsClient.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L105)
154
180
 
155
181
  Set the current user context for subsequent events.
156
182
 
@@ -14,6 +14,11 @@ Uses the official `@sentry/node` SDK for error tracking and analytics.
14
14
 
15
15
  - [`AnalyticsClientPort`](Class.AnalyticsClientPort)
16
16
 
17
+ ## Implements
18
+
19
+ - `OnModuleInit`
20
+ - `OnModuleDestroy`
21
+
17
22
  ## Constructors
18
23
 
19
24
  ### Constructor
@@ -22,7 +27,7 @@ Uses the official `@sentry/node` SDK for error tracking and analytics.
22
27
  new SentryAnalyticsClient(configService): SentryAnalyticsClient;
23
28
  ```
24
29
 
25
- Defined in: [sentry/SentryAnalyticsClient.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L30)
30
+ Defined in: [sentry/SentryAnalyticsClient.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L31)
26
31
 
27
32
  #### Parameters
28
33
 
@@ -46,7 +51,7 @@ Defined in: [sentry/SentryAnalyticsClient.ts:30](https://github.com/RueDeRennes/
46
51
  addBreadcrumb(breadcrumb): void;
47
52
  ```
48
53
 
49
- Defined in: [sentry/SentryAnalyticsClient.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L74)
54
+ Defined in: [sentry/SentryAnalyticsClient.ts:92](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L92)
50
55
 
51
56
  Add a breadcrumb entry to the analytics trail.
52
57
 
@@ -72,7 +77,7 @@ Add a breadcrumb entry to the analytics trail.
72
77
  captureException(error, context?): void;
73
78
  ```
74
79
 
75
- Defined in: [sentry/SentryAnalyticsClient.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L46)
80
+ Defined in: [sentry/SentryAnalyticsClient.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L64)
76
81
 
77
82
  Capture an exception with optional context.
78
83
 
@@ -102,7 +107,7 @@ captureMessage(
102
107
  context?): void;
103
108
  ```
104
109
 
105
- Defined in: [sentry/SentryAnalyticsClient.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L51)
110
+ Defined in: [sentry/SentryAnalyticsClient.ts:69](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L69)
106
111
 
107
112
  Capture a message with a specific severity level.
108
113
 
@@ -130,7 +135,7 @@ Capture a message with a specific severity level.
130
135
  clearUser(): void;
131
136
  ```
132
137
 
133
- Defined in: [sentry/SentryAnalyticsClient.ts:69](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L69)
138
+ Defined in: [sentry/SentryAnalyticsClient.ts:87](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L87)
134
139
 
135
140
  Clear the current user context.
136
141
 
@@ -144,13 +149,57 @@ Clear the current user context.
144
149
 
145
150
  ***
146
151
 
152
+ ### onModuleDestroy()
153
+
154
+ ```ts
155
+ onModuleDestroy(): Promise<void>;
156
+ ```
157
+
158
+ Defined in: [sentry/SentryAnalyticsClient.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L59)
159
+
160
+ Flushes pending Sentry events before shutdown.
161
+
162
+ #### Returns
163
+
164
+ `Promise`\<`void`\>
165
+
166
+ #### Implementation of
167
+
168
+ ```ts
169
+ OnModuleDestroy.onModuleDestroy
170
+ ```
171
+
172
+ ***
173
+
174
+ ### onModuleInit()
175
+
176
+ ```ts
177
+ onModuleInit(): void;
178
+ ```
179
+
180
+ Defined in: [sentry/SentryAnalyticsClient.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L45)
181
+
182
+ Initializes the Sentry SDK.
183
+
184
+ #### Returns
185
+
186
+ `void`
187
+
188
+ #### Implementation of
189
+
190
+ ```ts
191
+ OnModuleInit.onModuleInit
192
+ ```
193
+
194
+ ***
195
+
147
196
  ### setUser()
148
197
 
149
198
  ```ts
150
199
  setUser(user): void;
151
200
  ```
152
201
 
153
- Defined in: [sentry/SentryAnalyticsClient.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L59)
202
+ Defined in: [sentry/SentryAnalyticsClient.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L77)
154
203
 
155
204
  Set the current user context for subsequent events.
156
205
 
@@ -155,6 +155,19 @@ Each provider is tree-shakeable via sub-path imports:
155
155
 
156
156
  ---
157
157
 
158
+ ## Lifecycle & Shutdown
159
+
160
+ All built-in clients implement `OnModuleInit` and `OnModuleDestroy`:
161
+
162
+ | Phase | Behavior |
163
+ | ----------- | --------------------------------------------------------------------------- |
164
+ | **Init** | SDK initialization is deferred to `onModuleInit()` — no constructor I/O |
165
+ | **Destroy** | Pending events are flushed and the SDK is closed with a 5-second timeout |
166
+
167
+ This ensures no events are lost during application shutdown and prevents hanging processes if the analytics backend is unreachable.
168
+
169
+ ---
170
+
158
171
  ## Exports Summary
159
172
 
160
173
  | Export | Type | Description |
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: EventHub
7
7
 
8
- Defined in: [events/EventHub.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L38)
8
+ Defined in: [events/EventHub.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L37)
9
9
 
10
10
  Provides a strongly typed event hub that can publish and subscribe to events.
11
11
 
@@ -21,7 +21,7 @@ Provides a strongly typed event hub that can publish and subscribe to events.
21
21
  new EventHub(): EventHub;
22
22
  ```
23
23
 
24
- Defined in: [events/EventHub.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L51)
24
+ Defined in: [events/EventHub.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L49)
25
25
 
26
26
  Initializes a new instance of the EventHub class.
27
27
 
@@ -39,7 +39,7 @@ Initializes a new instance of the EventHub class.
39
39
  get events(): Observable<AnyEventNotification>;
40
40
  ```
41
41
 
42
- Defined in: [events/EventHub.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L65)
42
+ Defined in: [events/EventHub.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L63)
43
43
 
44
44
  Gets the observable sequence that exposes all events published within the hub.
45
45
 
@@ -55,7 +55,7 @@ Gets the observable sequence that exposes all events published within the hub.
55
55
  observe<TEvents, TKey>(eventKey): Observable<TEvents[TKey]>;
56
56
  ```
57
57
 
58
- Defined in: [events/EventHub.ts:118](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L118)
58
+ Defined in: [events/EventHub.ts:122](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L122)
59
59
 
60
60
  Returns an observable that emits payloads for the specified event.
61
61
 
@@ -86,7 +86,7 @@ An observable sequence that emits payloads of the specified event
86
86
  onModuleDestroy(): void;
87
87
  ```
88
88
 
89
- Defined in: [events/EventHub.ts:134](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L134)
89
+ Defined in: [events/EventHub.ts:140](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L140)
90
90
 
91
91
  Completes the event stream when the module is destroyed.
92
92
 
@@ -108,7 +108,7 @@ OnModuleDestroy.onModuleDestroy
108
108
  publish<TEvents, TKey>(eventKey, payload): void;
109
109
  ```
110
110
 
111
- Defined in: [events/EventHub.ts:80](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L80)
111
+ Defined in: [events/EventHub.ts:78](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L78)
112
112
 
113
113
  Publishes an event with the specified payload to all subscribers.
114
114
 
@@ -138,7 +138,7 @@ Publishes an event with the specified payload to all subscribers.
138
138
  subscribe<TEvents, TKey>(eventKey, handler): Subscription;
139
139
  ```
140
140
 
141
- Defined in: [events/EventHub.ts:101](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L101)
141
+ Defined in: [events/EventHub.ts:102](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L102)
142
142
 
143
143
  Subscribes to the specified event and invokes the handler whenever the event is published.
144
144
 
@@ -31,7 +31,7 @@ Defined in: [health/HealthOrchestrator.ts:27](https://github.com/RueDeRennes/arc
31
31
  check(): Promise<IHealthCheckResult[]>;
32
32
  ```
33
33
 
34
- Defined in: [health/HealthOrchestrator.ts:60](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/HealthOrchestrator.ts#L60)
34
+ Defined in: [health/HealthOrchestrator.ts:67](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/HealthOrchestrator.ts#L67)
35
35
 
36
36
  Executes all registered health indicators and aggregates their results.
37
37
 
@@ -12,6 +12,7 @@ Represents a server-sent event service.
12
12
  ## Implements
13
13
 
14
14
  - [`ISseHub`](Interface.ISseHub)
15
+ - `OnModuleDestroy`
15
16
 
16
17
  ## Constructors
17
18
 
@@ -37,7 +38,7 @@ Constructs a new instance of the `SseService` class.
37
38
  clearEvent(id): void;
38
39
  ```
39
40
 
40
- Defined in: [sse/services/SseHub.ts:98](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L98)
41
+ Defined in: [sse/services/SseHub.ts:122](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L122)
41
42
 
42
43
  Clears the event with the specified ID.
43
44
 
@@ -63,7 +64,7 @@ Clears the event with the specified ID.
63
64
  emitEvent(id, data): void;
64
65
  ```
65
66
 
66
- Defined in: [sse/services/SseHub.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L77)
67
+ Defined in: [sse/services/SseHub.ts:94](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L94)
67
68
 
68
69
  Emits an event with the specified ID and data.
69
70
 
@@ -90,7 +91,7 @@ Emits an event with the specified ID and data.
90
91
  getObservable(eventId): Observable<ISseEventData<unknown>>;
91
92
  ```
92
93
 
93
- Defined in: [sse/services/SseHub.ts:128](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L128)
94
+ Defined in: [sse/services/SseHub.ts:152](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L152)
94
95
 
95
96
  Gets an observable for the event with the specified ID.
96
97
 
@@ -118,7 +119,7 @@ An observable for the event.
118
119
  isEventActive(id): boolean;
119
120
  ```
120
121
 
121
- Defined in: [sse/services/SseHub.ts:115](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L115)
122
+ Defined in: [sse/services/SseHub.ts:139](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L139)
122
123
 
123
124
  Determines whether the event with the specified ID is active.
124
125
 
@@ -140,13 +141,35 @@ Determines whether the event with the specified ID is active.
140
141
 
141
142
  ***
142
143
 
144
+ ### onModuleDestroy()
145
+
146
+ ```ts
147
+ onModuleDestroy(): void;
148
+ ```
149
+
150
+ Defined in: [sse/services/SseHub.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L44)
151
+
152
+ Completes all active event subjects and clears the registry on module destruction.
153
+
154
+ #### Returns
155
+
156
+ `void`
157
+
158
+ #### Implementation of
159
+
160
+ ```ts
161
+ OnModuleDestroy.onModuleDestroy
162
+ ```
163
+
164
+ ***
165
+
143
166
  ### registerEvent()
144
167
 
145
168
  ```ts
146
169
  registerEvent(id): void;
147
170
  ```
148
171
 
149
- Defined in: [sse/services/SseHub.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L45)
172
+ Defined in: [sse/services/SseHub.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L58)
150
173
 
151
174
  Registers an event with the specified ID.
152
175
 
@@ -168,7 +191,7 @@ Registers an event with the specified ID.
168
191
  unregisterEvent(id): void;
169
192
  ```
170
193
 
171
- Defined in: [sse/services/SseHub.ts:60](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L60)
194
+ Defined in: [sse/services/SseHub.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L77)
172
195
 
173
196
  Unregisters an event with the specified ID.
174
197
 
@@ -463,6 +463,7 @@ export class OrderService {
463
463
  | `HostService` | Host configuration (title, logo, features, health endpoints) |
464
464
  | `UserAvatarGeneratorService` | Generate deterministic avatars from user identifiers |
465
465
  | `UsernameGeneratorService` | Generate random usernames from word lists |
466
+ | `SseHub` | Server-Sent Events hub — bounded to 10,000 event subjects |
466
467
 
467
468
  ---
468
469
 
@@ -475,7 +476,7 @@ export class OrderService {
475
476
  | `EventModule` | NestJS Module | Event pub/sub system |
476
477
  | `IdentifierModule` | NestJS Module | ID generation strategy |
477
478
  | `HostModule` | NestJS Module | Host services and templates |
478
- | `HealthModule` | NestJS Module | Health check orchestration |
479
+ | `HealthModule` | NestJS Module | Health check orchestration (max 100 indicators) |
479
480
  | `MappingService` | Service | Central object mapping |
480
481
  | `ConfigService` | Service | Type-safe config access (re-export from `platform-configuration`) |
481
482
  | `BcryptService` | Service | Password hashing |
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: CryptoService
7
7
 
8
- Defined in: [CryptoService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/CryptoService.ts#L15)
8
+ Defined in: [CryptoService.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/CryptoService.ts#L16)
9
9
 
10
10
  The `CryptoService` class.
11
11
  Represents the service that provides cryptographic operations.
@@ -18,7 +18,7 @@ Represents the service that provides cryptographic operations.
18
18
  new CryptoService(): CryptoService;
19
19
  ```
20
20
 
21
- Defined in: [CryptoService.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/CryptoService.ts#L21)
21
+ Defined in: [CryptoService.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/CryptoService.ts#L22)
22
22
 
23
23
  Initializes a new instance of the `CryptoService` class.
24
24
 
@@ -34,7 +34,7 @@ Initializes a new instance of the `CryptoService` class.
34
34
  getRandomGuid(prefix): string;
35
35
  ```
36
36
 
37
- Defined in: [CryptoService.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/CryptoService.ts#L36)
37
+ Defined in: [CryptoService.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/CryptoService.ts#L37)
38
38
 
39
39
  Generates a random GUID prefixed with the given string.
40
40
 
@@ -125,6 +125,16 @@ The default `TOTP_EPOCH_TOLERANCE` is 30 seconds (±1 time step):
125
125
 
126
126
  ---
127
127
 
128
+ ## Error Handling
129
+
130
+ `CryptoService` throws `CryptoValidationError` when provided with invalid input (e.g. empty UUID prefix). The error carries a `code` property set to `'CRYPTO_VALIDATION'`.
131
+
132
+ ```typescript
133
+ import { CryptoValidationError } from '@breadstone/archipel-platform-cryptography';
134
+ ```
135
+
136
+ ---
137
+
128
138
  ## API Reference
129
139
 
130
140
  See the full [API documentation](./api/) for all exported types and classes.
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: DocumentEngine
7
7
 
8
- Defined in: [engine/DocumentEngine.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L16)
8
+ Defined in: [engine/DocumentEngine.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L18)
9
9
 
10
10
  DocumentEngine orchestrates document generation workflow.
11
11
  Coordinates resource loading and renderer components.
@@ -18,7 +18,7 @@ Coordinates resource loading and renderer components.
18
18
  new DocumentEngine(resourceManager, renderers): DocumentEngine;
19
19
  ```
20
20
 
21
- Defined in: [engine/DocumentEngine.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L41)
21
+ Defined in: [engine/DocumentEngine.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L43)
22
22
 
23
23
  #### Parameters
24
24
 
@@ -41,7 +41,7 @@ Defined in: [engine/DocumentEngine.ts:41](https://github.com/RueDeRennes/archipe
41
41
  get renderers(): ReadonlyMap<string, IDocumentRenderer>;
42
42
  ```
43
43
 
44
- Defined in: [engine/DocumentEngine.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L33)
44
+ Defined in: [engine/DocumentEngine.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L35)
45
45
 
46
46
  Get available renderers.
47
47
 
@@ -61,7 +61,7 @@ render(options): Promise<IRenderResult & {
61
61
  }>;
62
62
  ```
63
63
 
64
- Defined in: [engine/DocumentEngine.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L68)
64
+ Defined in: [engine/DocumentEngine.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L70)
65
65
 
66
66
  Render a document from template.
67
67
 
@@ -0,0 +1,61 @@
1
+ ---
2
+ title: 'Abstract Class: DocumentError'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Abstract Class: DocumentError
7
+
8
+ Defined in: [errors/DocumentError.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/errors/DocumentError.ts#L7)
9
+
10
+ Base class for document-related domain errors.
11
+
12
+ ## Extends
13
+
14
+ - `Error`
15
+
16
+ ## Extended by
17
+
18
+ - [`DocumentRenderError`](Class.DocumentRenderError)
19
+ - [`DocumentValidationError`](Class.DocumentValidationError)
20
+ - [`ImageProcessingError`](Class.ImageProcessingError)
21
+
22
+ ## Constructors
23
+
24
+ ### Constructor
25
+
26
+ ```ts
27
+ protected new DocumentError(
28
+ message,
29
+ code,
30
+ cause?): DocumentError;
31
+ ```
32
+
33
+ Defined in: [errors/DocumentError.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/errors/DocumentError.ts#L16)
34
+
35
+ #### Parameters
36
+
37
+ | Parameter | Type |
38
+ | ------ | ------ |
39
+ | `message` | `string` |
40
+ | `code` | `string` |
41
+ | `cause?` | `unknown` |
42
+
43
+ #### Returns
44
+
45
+ `DocumentError`
46
+
47
+ #### Overrides
48
+
49
+ ```ts
50
+ Error.constructor
51
+ ```
52
+
53
+ ## Properties
54
+
55
+ ### code
56
+
57
+ ```ts
58
+ readonly code: string;
59
+ ```
60
+
61
+ Defined in: [errors/DocumentError.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/errors/DocumentError.ts#L10)
@@ -0,0 +1,53 @@
1
+ ---
2
+ title: 'Class: DocumentRenderError'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Class: DocumentRenderError
7
+
8
+ Defined in: [errors/DocumentRenderError.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/errors/DocumentRenderError.ts#L8)
9
+
10
+ Thrown when document rendering fails.
11
+
12
+ ## Extends
13
+
14
+ - [`DocumentError`](Class.DocumentError)
15
+
16
+ ## Constructors
17
+
18
+ ### Constructor
19
+
20
+ ```ts
21
+ new DocumentRenderError(message, cause?): DocumentRenderError;
22
+ ```
23
+
24
+ Defined in: [errors/DocumentRenderError.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/errors/DocumentRenderError.ts#L11)
25
+
26
+ #### Parameters
27
+
28
+ | Parameter | Type |
29
+ | ------ | ------ |
30
+ | `message` | `string` |
31
+ | `cause?` | `unknown` |
32
+
33
+ #### Returns
34
+
35
+ `DocumentRenderError`
36
+
37
+ #### Overrides
38
+
39
+ [`DocumentError`](Class.DocumentError).[`constructor`](Class.DocumentError#constructor)
40
+
41
+ ## Properties
42
+
43
+ ### code
44
+
45
+ ```ts
46
+ readonly code: string;
47
+ ```
48
+
49
+ Defined in: [errors/DocumentError.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/errors/DocumentError.ts#L10)
50
+
51
+ #### Inherited from
52
+
53
+ [`DocumentError`](Class.DocumentError).[`code`](Class.DocumentError#code)
@@ -0,0 +1,52 @@
1
+ ---
2
+ title: 'Class: DocumentValidationError'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Class: DocumentValidationError
7
+
8
+ Defined in: [errors/DocumentValidationError.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/errors/DocumentValidationError.ts#L8)
9
+
10
+ Thrown when document input validation fails.
11
+
12
+ ## Extends
13
+
14
+ - [`DocumentError`](Class.DocumentError)
15
+
16
+ ## Constructors
17
+
18
+ ### Constructor
19
+
20
+ ```ts
21
+ new DocumentValidationError(message): DocumentValidationError;
22
+ ```
23
+
24
+ Defined in: [errors/DocumentValidationError.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/errors/DocumentValidationError.ts#L11)
25
+
26
+ #### Parameters
27
+
28
+ | Parameter | Type |
29
+ | ------ | ------ |
30
+ | `message` | `string` |
31
+
32
+ #### Returns
33
+
34
+ `DocumentValidationError`
35
+
36
+ #### Overrides
37
+
38
+ [`DocumentError`](Class.DocumentError).[`constructor`](Class.DocumentError#constructor)
39
+
40
+ ## Properties
41
+
42
+ ### code
43
+
44
+ ```ts
45
+ readonly code: string;
46
+ ```
47
+
48
+ Defined in: [errors/DocumentError.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/errors/DocumentError.ts#L10)
49
+
50
+ #### Inherited from
51
+
52
+ [`DocumentError`](Class.DocumentError).[`code`](Class.DocumentError#code)