@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
@@ -7,10 +7,14 @@ editUrl: false
7
7
 
8
8
  Defined in: [metrics/MetricsService.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/metrics/MetricsService.ts#L25)
9
9
 
10
- Provides lazily-initialized OpenTelemetry metric instruments.
10
+ Provides eagerly-initialized OpenTelemetry metric instruments.
11
11
 
12
12
  Replaces the former module-level `let instruments` closure (TEL-4).
13
13
 
14
+ ## Implements
15
+
16
+ - `OnModuleInit`
17
+
14
18
  ## Constructors
15
19
 
16
20
  ### Constructor
@@ -31,10 +35,32 @@ new MetricsService(): MetricsService;
31
35
  getInstruments(): IMetricInstruments | undefined;
32
36
  ```
33
37
 
34
- Defined in: [metrics/MetricsService.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/metrics/MetricsService.ts#L38)
38
+ Defined in: [metrics/MetricsService.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/metrics/MetricsService.ts#L61)
35
39
 
36
- Returns the cached metric instruments, creating them on first access.
40
+ Returns the cached metric instruments.
37
41
 
38
42
  #### Returns
39
43
 
40
44
  [`IMetricInstruments`](Interface.IMetricInstruments) \| `undefined`
45
+
46
+ ***
47
+
48
+ ### onModuleInit()
49
+
50
+ ```ts
51
+ onModuleInit(): void;
52
+ ```
53
+
54
+ Defined in: [metrics/MetricsService.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/metrics/MetricsService.ts#L40)
55
+
56
+ Eagerly initializes metric instruments at module startup.
57
+
58
+ #### Returns
59
+
60
+ `void`
61
+
62
+ #### Implementation of
63
+
64
+ ```ts
65
+ OnModuleInit.onModuleInit
66
+ ```
@@ -36,7 +36,7 @@ new OtelSdkHolder(): OtelSdkHolder;
36
36
  onApplicationShutdown(): Promise<void>;
37
37
  ```
38
38
 
39
- Defined in: [OtelSdkHolder.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/OtelSdkHolder.ts#L34)
39
+ Defined in: [OtelSdkHolder.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/OtelSdkHolder.ts#L39)
40
40
 
41
41
  #### Returns
42
42
 
@@ -58,9 +58,10 @@ OnApplicationShutdown.onApplicationShutdown
58
58
  setSdk(sdk): void;
59
59
  ```
60
60
 
61
- Defined in: [OtelSdkHolder.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/OtelSdkHolder.ts#L29)
61
+ Defined in: [OtelSdkHolder.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/OtelSdkHolder.ts#L30)
62
62
 
63
63
  Stores the SDK reference so it can be shut down later.
64
+ Can only be called once — subsequent calls are ignored.
64
65
 
65
66
  #### Parameters
66
67
 
@@ -23,7 +23,7 @@ Defined in: [logger/TelemetryLoggerService.ts:5](https://github.com/RueDeRennes/
23
23
  new TelemetryLoggerService(ruleEngine?): TelemetryLoggerService;
24
24
  ```
25
25
 
26
- Defined in: [logger/TelemetryLoggerService.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/logger/TelemetryLoggerService.ts#L12)
26
+ Defined in: [logger/TelemetryLoggerService.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/logger/TelemetryLoggerService.ts#L11)
27
27
 
28
28
  #### Parameters
29
29
 
@@ -49,7 +49,7 @@ ConsoleLogger.constructor
49
49
  debug(message, context?): void;
50
50
  ```
51
51
 
52
- Defined in: [logger/TelemetryLoggerService.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/logger/TelemetryLoggerService.ts#L19)
52
+ Defined in: [logger/TelemetryLoggerService.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/logger/TelemetryLoggerService.ts#L30)
53
53
 
54
54
  Write a 'debug' level log, if the configured level allows for it.
55
55
  Prints to `stdout` with newline.
@@ -88,7 +88,7 @@ error(
88
88
  context?): void;
89
89
  ```
90
90
 
91
- Defined in: [logger/TelemetryLoggerService.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/logger/TelemetryLoggerService.ts#L17)
91
+ Defined in: [logger/TelemetryLoggerService.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/logger/TelemetryLoggerService.ts#L22)
92
92
 
93
93
  Write an 'error' level log, if the configured level allows for it.
94
94
  Prints to `stderr` with newline.
@@ -125,7 +125,7 @@ ConsoleLogger.error
125
125
  log(message, context?): void;
126
126
  ```
127
127
 
128
- Defined in: [logger/TelemetryLoggerService.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/logger/TelemetryLoggerService.ts#L16)
128
+ Defined in: [logger/TelemetryLoggerService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/logger/TelemetryLoggerService.ts#L18)
129
129
 
130
130
  Write a 'log' level log, if the configured level allows for it.
131
131
  Prints to `stdout` with newline.
@@ -161,7 +161,7 @@ ConsoleLogger.log
161
161
  verbose(message, context?): void;
162
162
  ```
163
163
 
164
- Defined in: [logger/TelemetryLoggerService.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/logger/TelemetryLoggerService.ts#L20)
164
+ Defined in: [logger/TelemetryLoggerService.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/logger/TelemetryLoggerService.ts#L34)
165
165
 
166
166
  Write a 'verbose' level log, if the configured level allows for it.
167
167
  Prints to `stdout` with newline.
@@ -197,7 +197,7 @@ ConsoleLogger.verbose
197
197
  warn(message, context?): void;
198
198
  ```
199
199
 
200
- Defined in: [logger/TelemetryLoggerService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/logger/TelemetryLoggerService.ts#L18)
200
+ Defined in: [logger/TelemetryLoggerService.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/logger/TelemetryLoggerService.ts#L26)
201
201
 
202
202
  Write a 'warn' level log, if the configured level allows for it.
203
203
  Prints to `stdout` with newline.
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: TelemetryRuleEngine
7
7
 
8
- Defined in: [rules/TelemetryRuleEngine.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/rules/TelemetryRuleEngine.ts#L11)
8
+ Defined in: [rules/TelemetryRuleEngine.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/rules/TelemetryRuleEngine.ts#L12)
9
9
 
10
10
  ## Constructors
11
11
 
@@ -15,7 +15,7 @@ Defined in: [rules/TelemetryRuleEngine.ts:11](https://github.com/RueDeRennes/arc
15
15
  new TelemetryRuleEngine(options, metricsService): TelemetryRuleEngine;
16
16
  ```
17
17
 
18
- Defined in: [rules/TelemetryRuleEngine.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/rules/TelemetryRuleEngine.ts#L18)
18
+ Defined in: [rules/TelemetryRuleEngine.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/rules/TelemetryRuleEngine.ts#L20)
19
19
 
20
20
  #### Parameters
21
21
 
@@ -36,7 +36,7 @@ Defined in: [rules/TelemetryRuleEngine.ts:18](https://github.com/RueDeRennes/arc
36
36
  process(message): void;
37
37
  ```
38
38
 
39
- Defined in: [rules/TelemetryRuleEngine.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/rules/TelemetryRuleEngine.ts#L25)
39
+ Defined in: [rules/TelemetryRuleEngine.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/rules/TelemetryRuleEngine.ts#L27)
40
40
 
41
41
  #### Parameters
42
42
 
@@ -9,7 +9,7 @@ editUrl: false
9
9
 
10
10
  | Class | Description |
11
11
  | ------ | ------ |
12
- | [MetricsService](Class.MetricsService) | Provides lazily-initialized OpenTelemetry metric instruments. |
12
+ | [MetricsService](Class.MetricsService) | Provides eagerly-initialized OpenTelemetry metric instruments. |
13
13
  | [NoopTelemetryFacade](Class.NoopTelemetryFacade) | - |
14
14
  | [OtelSdkHolder](Class.OtelSdkHolder) | Holds a reference to the OpenTelemetry NodeSDK instance and performs a graceful shutdown when the application terminates. |
15
15
  | [TelemetryCacheMetricsRecorder](Class.TelemetryCacheMetricsRecorder) | Generic cache metrics recorder that forwards cache lifecycle events into the telemetry facade (which may be a noop when disabled). |
@@ -164,7 +164,9 @@ The module initializes these OTEL components:
164
164
  | Metrics exporter | OTLP/HTTP |
165
165
  | Express instrumentation | `@opentelemetry/instrumentation-express` |
166
166
  | HTTP instrumentation | `@opentelemetry/instrumentation-http` |
167
- | SDK shutdown hook | Graceful on `OnModuleDestroy` |
167
+ | SDK shutdown hook | Graceful on `OnModuleDestroy` (5-second timeout) |
168
+ | SDK init guard | `OtelSdkHolder` write-once — prevents double-init |
169
+ | Metric instruments | Eager init via `MetricsService.onModuleInit()` |
168
170
 
169
171
  ---
170
172
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@breadstone/archipel-mcp",
3
- "version": "0.0.19",
3
+ "version": "0.0.21",
4
4
  "description": "MCP server providing Archipel platform knowledge — documentation, query patterns, and coding conventions — to AI development tools.",
5
5
  "type": "commonjs",
6
6
  "main": "./src/main.js",