@breadstone/archipel-mcp 0.0.20 → 0.0.22
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.
- package/data/guides/ai-text-generation.md +10 -0
- package/data/guides/analytics-and-error-tracking.md +6 -0
- package/data/guides/cryptography-and-otp.md +20 -2
- package/data/guides/database-setup.md +4 -3
- package/data/guides/document-generation.md +26 -0
- package/data/guides/email-delivery.md +23 -0
- package/data/guides/email-templates.md +298 -0
- package/data/guides/esigning-integration.md +1 -1
- package/data/guides/getting-started.md +6 -6
- package/data/guides/index.md +1 -0
- package/data/guides/mcp-server.md +9 -0
- package/data/guides/payments-and-feature-gating.md +18 -0
- package/data/guides/resource-management.md +9 -9
- package/data/guides/telemetry-and-observability.md +7 -1
- package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +55 -6
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +32 -6
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +55 -6
- package/data/packages/platform-analytics/index.md +13 -0
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +1 -1
- package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +1 -1
- package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +1 -1
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +1 -1
- package/data/packages/platform-core/api/Class.ErrorTemplateService.md +1 -1
- package/data/packages/platform-core/api/Class.EventHub.md +7 -7
- package/data/packages/platform-core/api/Class.HostService.md +1 -1
- package/data/packages/platform-core/api/Class.SseHub.md +29 -6
- package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +1 -1
- package/data/packages/platform-core/api/index.md +0 -27
- package/data/packages/platform-core/index.md +8 -4
- package/data/packages/platform-cryptography/api/Class.BcryptService.md +4 -4
- package/data/packages/platform-cryptography/api/Class.CryptoService.md +3 -3
- package/data/packages/platform-cryptography/api/Class.OtpService.md +6 -6
- package/data/packages/platform-cryptography/api/Variable.BCRYPT_OPTIONS.md +2 -2
- package/data/packages/platform-cryptography/api/Variable.MAX_BCRYPT_PASSWORD_BYTES.md +1 -1
- package/data/packages/platform-cryptography/api/Variable.MIN_BCRYPT_ROUNDS.md +1 -1
- package/data/packages/platform-cryptography/api/Variable.OTP_OPTIONS.md +2 -2
- package/data/packages/platform-cryptography/api/Variable.OTP_SERVICE_TOKEN.md +2 -2
- package/data/packages/platform-cryptography/api/Variable.TOTP_EPOCH_TOLERANCE.md +1 -1
- package/data/packages/platform-cryptography/api/index.md +3 -3
- package/data/packages/platform-cryptography/index.md +10 -0
- package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +32 -1
- package/data/packages/platform-documents/api/Class.DocumentEngine.md +4 -4
- package/data/packages/platform-documents/api/Class.DocumentError.md +61 -0
- package/data/packages/platform-documents/api/Class.DocumentModule.md +2 -2
- package/data/packages/platform-documents/api/Class.DocumentRenderError.md +53 -0
- package/data/packages/platform-documents/api/Class.DocumentValidationError.md +52 -0
- package/data/packages/platform-documents/api/Class.DocxDocumentRenderer2.md +333 -0
- package/data/packages/platform-documents/api/Class.ImageProcessingError.md +53 -0
- package/data/packages/platform-documents/api/Class.PdfDocumentRenderer.md +355 -0
- package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +5 -5
- package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +31 -5
- package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +1 -1
- package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +1 -1
- package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +1 -1
- package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +1 -1
- package/data/packages/platform-documents/api/index.md +6 -0
- package/data/packages/platform-documents/index.md +27 -0
- package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +2 -2
- package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +8 -8
- package/data/packages/platform-esigning/index.md +2 -0
- package/data/packages/platform-health/index.md +128 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +3 -3
- package/data/packages/platform-intelligence/api/Class.IntelligenceConfigurationError.md +50 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +27 -4
- package/data/packages/platform-intelligence/api/Class.IntelligenceValidationError.md +50 -0
- package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +1 -1
- package/data/packages/platform-intelligence/api/index.md +2 -0
- package/data/packages/platform-intelligence/index.md +32 -0
- package/data/packages/platform-logging/api/Class.LoggerModule.md +1 -1
- package/data/packages/platform-logging/index.md +2 -0
- package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +0 -1
- package/data/packages/platform-mailing/api/Class.MailDeliveryError.md +65 -0
- package/data/packages/platform-mailing/api/Class.MailModule.md +1 -1
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +0 -5
- package/data/packages/platform-mailing/api/Variable.SMTP_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-mailing/api/Variable.SMTP_HOST.md +14 -0
- package/data/packages/platform-mailing/api/Variable.SMTP_PASSWORD.md +14 -0
- package/data/packages/platform-mailing/api/Variable.SMTP_PORT.md +14 -0
- package/data/packages/platform-mailing/api/Variable.SMTP_SECURE.md +14 -0
- package/data/packages/platform-mailing/api/Variable.SMTP_USER.md +14 -0
- package/data/packages/platform-mailing/api/index.md +7 -3
- package/data/packages/platform-mailing/index.md +29 -0
- package/data/packages/platform-mapping/index.md +121 -0
- package/data/packages/platform-mcp/api/Class.McpServerService.md +8 -8
- package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +1 -1
- package/data/packages/platform-mcp/index.md +11 -0
- package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +4 -4
- package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +2 -2
- package/data/packages/platform-openapi/index.md +1 -1
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +6 -6
- package/data/packages/platform-payments/api/Class.MollieClient.md +6 -6
- package/data/packages/platform-payments/api/Class.PaddleClient.md +6 -6
- package/data/packages/platform-payments/api/Class.PaymentError.md +65 -0
- package/data/packages/platform-payments/api/Class.StripeClient.md +6 -6
- package/data/packages/platform-payments/api/index.md +1 -0
- package/data/packages/platform-payments/index.md +29 -0
- package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +1 -1
- package/data/packages/platform-reporting/index.md +3 -1
- package/data/packages/platform-resources/index.md +135 -0
- package/data/packages/platform-telemetry/api/Class.MetricsService.md +29 -3
- package/data/packages/platform-telemetry/api/Class.OtelSdkHolder.md +3 -2
- package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +6 -6
- package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +3 -3
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +1 -1
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +1 -1
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +1 -1
- package/data/packages/platform-telemetry/api/index.md +1 -1
- package/data/packages/platform-telemetry/index.md +3 -1
- package/{src/knowledge/configPattern.js → data/patterns/config-pattern.md} +44 -47
- package/{src/knowledge/dtoPattern.js → data/patterns/dto-pattern.md} +58 -61
- package/{src/knowledge/errorHandlingPattern.js → data/patterns/error-handling-pattern.md} +35 -38
- package/{src/knowledge/guardPattern.js → data/patterns/guard-pattern.md} +35 -38
- package/{src/knowledge/mappingPattern.js → data/patterns/mapping-pattern.md} +43 -144
- package/data/patterns/module-pattern.md +182 -0
- package/data/patterns/query-pattern.md +137 -0
- package/data/patterns/repository-pattern.md +208 -0
- package/{src/knowledge/testingPattern.js → data/patterns/testing-pattern.md} +37 -40
- package/package.json +1 -1
- package/src/PatternsLoader.d.ts +12 -0
- package/src/PatternsLoader.js +65 -0
- package/src/generators/mappingPatternGenerator.d.ts +5 -0
- package/src/generators/mappingPatternGenerator.js +107 -0
- package/src/generators/modulePatternGenerator.d.ts +5 -0
- package/src/generators/modulePatternGenerator.js +107 -0
- package/src/generators/queryPatternGenerator.d.ts +4 -0
- package/src/generators/queryPatternGenerator.js +83 -0
- package/src/generators/repositoryPatternGenerator.d.ts +5 -0
- package/src/generators/repositoryPatternGenerator.js +165 -0
- package/src/main.js +15 -9
- package/src/models/IPatternDoc.d.ts +15 -0
- package/src/models/IPatternDoc.js +3 -0
- package/src/tools/registerGetConfigPatternTool.d.ts +2 -1
- package/src/tools/registerGetConfigPatternTool.js +4 -3
- package/src/tools/registerGetDtoPatternTool.d.ts +2 -1
- package/src/tools/registerGetDtoPatternTool.js +4 -3
- package/src/tools/registerGetErrorHandlingPatternTool.d.ts +2 -1
- package/src/tools/registerGetErrorHandlingPatternTool.js +4 -3
- package/src/tools/registerGetGuardPatternTool.d.ts +2 -1
- package/src/tools/registerGetGuardPatternTool.js +4 -3
- package/src/tools/registerGetMappingPatternTool.d.ts +2 -1
- package/src/tools/registerGetMappingPatternTool.js +5 -4
- package/src/tools/registerGetModulePatternTool.d.ts +2 -1
- package/src/tools/registerGetModulePatternTool.js +5 -4
- package/src/tools/registerGetQueryPatternTool.d.ts +2 -1
- package/src/tools/registerGetQueryPatternTool.js +5 -4
- package/src/tools/registerGetRepositoryPatternTool.d.ts +2 -1
- package/src/tools/registerGetRepositoryPatternTool.js +5 -4
- package/src/tools/registerGetTestingPatternTool.d.ts +2 -1
- package/src/tools/registerGetTestingPatternTool.js +4 -3
- package/data/packages/platform-core/api/Class.BlobResourceStrategy.md +0 -195
- package/data/packages/platform-core/api/Class.EmbeddedResourceStrategy.md +0 -215
- package/data/packages/platform-core/api/Class.FileResourceStrategy.md +0 -192
- package/data/packages/platform-core/api/Class.HealthModule.md +0 -42
- package/data/packages/platform-core/api/Class.HealthOrchestrator.md +0 -64
- package/data/packages/platform-core/api/Class.MappingBuilder.md +0 -110
- package/data/packages/platform-core/api/Class.MappingModule.md +0 -46
- package/data/packages/platform-core/api/Class.MappingNotRegisteredError.md +0 -56
- package/data/packages/platform-core/api/Class.MappingProfileBase.md +0 -52
- package/data/packages/platform-core/api/Class.MappingService.md +0 -284
- package/data/packages/platform-core/api/Class.ResourceManager.md +0 -565
- package/data/packages/platform-core/api/Class.ResourceModule.md +0 -46
- package/data/packages/platform-core/api/Class.TypeMappingNotRegisteredError.md +0 -57
- package/data/packages/platform-core/api/Function.createMappingKey.md +0 -39
- package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md +0 -28
- package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md +0 -40
- package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md +0 -72
- package/data/packages/platform-core/api/Interface.IHealthCheckResult.md +0 -46
- package/data/packages/platform-core/api/Interface.IHealthIndicator.md +0 -41
- package/data/packages/platform-core/api/Interface.IMappingBuilder.md +0 -76
- package/data/packages/platform-core/api/Interface.IMappingKey.md +0 -58
- package/data/packages/platform-core/api/Interface.IMappingProfile.md +0 -32
- package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +0 -89
- package/data/packages/platform-core/api/Interface.IResourceMetadata.md +0 -94
- package/data/packages/platform-core/api/Interface.IResourceResult.md +0 -34
- package/data/packages/platform-core/api/Interface.IResourceStrategy.md +0 -134
- package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +0 -14
- package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +0 -60
- package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +0 -58
- package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +0 -71
- package/src/knowledge/configPattern.d.ts +0 -5
- package/src/knowledge/dtoPattern.d.ts +0 -5
- package/src/knowledge/errorHandlingPattern.d.ts +0 -5
- package/src/knowledge/guardPattern.d.ts +0 -5
- package/src/knowledge/mappingPattern.d.ts +0 -6
- package/src/knowledge/modulePattern.d.ts +0 -6
- package/src/knowledge/modulePattern.js +0 -283
- package/src/knowledge/queryPattern.d.ts +0 -6
- package/src/knowledge/queryPattern.js +0 -215
- package/src/knowledge/repositoryPattern.d.ts +0 -6
- package/src/knowledge/repositoryPattern.js +0 -367
- package/src/knowledge/testingPattern.d.ts +0 -5
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: platform-health
|
|
3
|
+
description: Health check orchestration with indicator-based architecture built on @nestjs/terminus.
|
|
4
|
+
order: 4
|
|
5
|
+
tags: [health, terminus, indicators, monitoring]
|
|
6
|
+
package: '@breadstone/archipel-platform-health'
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# platform-health
|
|
10
|
+
|
|
11
|
+
Health check orchestration for NestJS applications built on `@nestjs/terminus`. Register custom health indicators and expose aggregated health status via a single orchestrator. Extracted from `platform-core` to provide a focused, independently versionable health module.
|
|
12
|
+
|
|
13
|
+
**Package:** `@breadstone/archipel-platform-health`
|
|
14
|
+
|
|
15
|
+
## Installation
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import {
|
|
19
|
+
HealthModule,
|
|
20
|
+
HealthOrchestrator,
|
|
21
|
+
IHealthIndicator,
|
|
22
|
+
IHealthCheckResult,
|
|
23
|
+
HEALTH_INDICATORS,
|
|
24
|
+
} from '@breadstone/archipel-platform-health';
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## Module Registration
|
|
30
|
+
|
|
31
|
+
Register the module with one or more health indicators:
|
|
32
|
+
|
|
33
|
+
```typescript
|
|
34
|
+
import { Module } from '@nestjs/common';
|
|
35
|
+
import { HealthModule } from '@breadstone/archipel-platform-health';
|
|
36
|
+
import { DatabaseHealthIndicator } from './health/DatabaseHealthIndicator';
|
|
37
|
+
import { RedisHealthIndicator } from './health/RedisHealthIndicator';
|
|
38
|
+
|
|
39
|
+
@Module({
|
|
40
|
+
imports: [
|
|
41
|
+
HealthModule.withIndicators([DatabaseHealthIndicator, RedisHealthIndicator]),
|
|
42
|
+
],
|
|
43
|
+
})
|
|
44
|
+
export class AppModule {}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Implementing a Health Indicator
|
|
48
|
+
|
|
49
|
+
Each indicator implements the `IHealthIndicator` interface:
|
|
50
|
+
|
|
51
|
+
```typescript
|
|
52
|
+
import { Injectable } from '@nestjs/common';
|
|
53
|
+
import type { IHealthIndicator, IHealthCheckResult } from '@breadstone/archipel-platform-health';
|
|
54
|
+
|
|
55
|
+
@Injectable()
|
|
56
|
+
export class DatabaseHealthIndicator implements IHealthIndicator {
|
|
57
|
+
public readonly name = 'database';
|
|
58
|
+
|
|
59
|
+
public async isHealthy(): Promise<IHealthCheckResult> {
|
|
60
|
+
try {
|
|
61
|
+
await this._prisma.$queryRaw`SELECT 1`;
|
|
62
|
+
return { status: 'up' };
|
|
63
|
+
} catch (error) {
|
|
64
|
+
return { status: 'down', details: { error: (error as Error).message } };
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Using the Orchestrator
|
|
71
|
+
|
|
72
|
+
The `HealthOrchestrator` runs all registered indicators and returns aggregated results:
|
|
73
|
+
|
|
74
|
+
```typescript
|
|
75
|
+
import { Controller, Get } from '@nestjs/common';
|
|
76
|
+
import { HealthOrchestrator } from '@breadstone/archipel-platform-health';
|
|
77
|
+
|
|
78
|
+
@Controller('health')
|
|
79
|
+
export class HealthController {
|
|
80
|
+
constructor(private readonly _healthOrchestrator: HealthOrchestrator) {}
|
|
81
|
+
|
|
82
|
+
@Get()
|
|
83
|
+
public async check(): Promise<unknown> {
|
|
84
|
+
return this._healthOrchestrator.check();
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
## Built-in Consumers
|
|
92
|
+
|
|
93
|
+
Several Archipel libraries automatically register health indicators when imported alongside `platform-health`:
|
|
94
|
+
|
|
95
|
+
| Library | Indicator | Check |
|
|
96
|
+
| ---------------------- | -------------------------- | ----------------------------- |
|
|
97
|
+
| `platform-database` | `DatabaseHealthIndicator` | `SELECT 1` ping |
|
|
98
|
+
| `platform-blob-storage`| `BlobHealthIndicator` | Blob storage connectivity |
|
|
99
|
+
| `platform-mailing` | `MailHealthIndicator` | Mail server connectivity |
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
## Interfaces
|
|
104
|
+
|
|
105
|
+
| Interface | Description |
|
|
106
|
+
| ---------------------- | ----------------------------------------------------------------- |
|
|
107
|
+
| `IHealthIndicator` | Contract for health check implementations (`name` + `isHealthy`) |
|
|
108
|
+
| `IHealthCheckResult` | Result object with `status` (`'up'` or `'down'`) and optional `details` |
|
|
109
|
+
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
## Tokens
|
|
113
|
+
|
|
114
|
+
| Token | Description |
|
|
115
|
+
| -------------------- | -------------------------------------------------------- |
|
|
116
|
+
| `HEALTH_INDICATORS` | Multi-provider token for registering health indicators |
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
## Resource Bounds
|
|
121
|
+
|
|
122
|
+
The `HealthOrchestrator` enforces a maximum of **100** registered indicators. If the limit is exceeded, the indicator is skipped and a warning is logged.
|
|
123
|
+
|
|
124
|
+
---
|
|
125
|
+
|
|
126
|
+
## API Reference
|
|
127
|
+
|
|
128
|
+
See the auto-generated [API Reference](./api/) for full details on all exported classes, interfaces, and types.
|
|
@@ -33,7 +33,7 @@ new IntelligenceCapabilityRegistry(): IntelligenceCapabilityRegistry;
|
|
|
33
33
|
list(): readonly IIntelligenceCapability[];
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
Defined in: [IntelligenceCapabilityRegistry.ts:
|
|
36
|
+
Defined in: [IntelligenceCapabilityRegistry.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceCapabilityRegistry.ts#L45)
|
|
37
37
|
|
|
38
38
|
Returns a read-only snapshot of all registered capabilities.
|
|
39
39
|
|
|
@@ -55,7 +55,7 @@ A defensive copy of the registered capabilities.
|
|
|
55
55
|
register(capability): void;
|
|
56
56
|
```
|
|
57
57
|
|
|
58
|
-
Defined in: [IntelligenceCapabilityRegistry.ts:
|
|
58
|
+
Defined in: [IntelligenceCapabilityRegistry.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceCapabilityRegistry.ts#L27)
|
|
59
59
|
|
|
60
60
|
Registers a capability in the registry.
|
|
61
61
|
|
|
@@ -83,7 +83,7 @@ resolve(intent, context):
|
|
|
83
83
|
| null;
|
|
84
84
|
```
|
|
85
85
|
|
|
86
|
-
Defined in: [IntelligenceCapabilityRegistry.ts:
|
|
86
|
+
Defined in: [IntelligenceCapabilityRegistry.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceCapabilityRegistry.ts#L40)
|
|
87
87
|
|
|
88
88
|
Resolves the most suitable capability for the given intent and context.
|
|
89
89
|
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Class: IntelligenceConfigurationError'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Class: IntelligenceConfigurationError
|
|
7
|
+
|
|
8
|
+
Defined in: [errors/IntelligenceConfigurationError.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceConfigurationError.ts#L6)
|
|
9
|
+
|
|
10
|
+
Error thrown when an intelligence provider configuration is invalid or missing.
|
|
11
|
+
|
|
12
|
+
## Extends
|
|
13
|
+
|
|
14
|
+
- `Error`
|
|
15
|
+
|
|
16
|
+
## Constructors
|
|
17
|
+
|
|
18
|
+
### Constructor
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
new IntelligenceConfigurationError(message): IntelligenceConfigurationError;
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Defined in: [errors/IntelligenceConfigurationError.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceConfigurationError.ts#L15)
|
|
25
|
+
|
|
26
|
+
#### Parameters
|
|
27
|
+
|
|
28
|
+
| Parameter | Type |
|
|
29
|
+
| ------ | ------ |
|
|
30
|
+
| `message` | `string` |
|
|
31
|
+
|
|
32
|
+
#### Returns
|
|
33
|
+
|
|
34
|
+
`IntelligenceConfigurationError`
|
|
35
|
+
|
|
36
|
+
#### Overrides
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
Error.constructor
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Properties
|
|
43
|
+
|
|
44
|
+
### code
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
readonly code: "INTELLIGENCE_CONFIGURATION" = 'INTELLIGENCE_CONFIGURATION';
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Defined in: [errors/IntelligenceConfigurationError.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceConfigurationError.ts#L9)
|
|
@@ -5,13 +5,14 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: IntelligenceTextGenerator
|
|
7
7
|
|
|
8
|
-
Defined in: [IntelligenceTextGenerator.ts:
|
|
8
|
+
Defined in: [IntelligenceTextGenerator.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L54)
|
|
9
9
|
|
|
10
10
|
Executes text completions using the configured intelligence provider.
|
|
11
11
|
|
|
12
12
|
## Implements
|
|
13
13
|
|
|
14
14
|
- [`IIntelligenceTextGenerator`](Interface.IIntelligenceTextGenerator)
|
|
15
|
+
- `OnModuleInit`
|
|
15
16
|
|
|
16
17
|
## Constructors
|
|
17
18
|
|
|
@@ -21,7 +22,7 @@ Executes text completions using the configured intelligence provider.
|
|
|
21
22
|
new IntelligenceTextGenerator(configService): IntelligenceTextGenerator;
|
|
22
23
|
```
|
|
23
24
|
|
|
24
|
-
Defined in: [IntelligenceTextGenerator.ts:
|
|
25
|
+
Defined in: [IntelligenceTextGenerator.ts:67](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L67)
|
|
25
26
|
|
|
26
27
|
#### Parameters
|
|
27
28
|
|
|
@@ -41,7 +42,7 @@ Defined in: [IntelligenceTextGenerator.ts:65](https://github.com/RueDeRennes/arc
|
|
|
41
42
|
generateText(prompt, options?): Promise<IIntelligenceTextCompletion>;
|
|
42
43
|
```
|
|
43
44
|
|
|
44
|
-
Defined in: [IntelligenceTextGenerator.ts:
|
|
45
|
+
Defined in: [IntelligenceTextGenerator.ts:99](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L99)
|
|
45
46
|
|
|
46
47
|
Generates a completion using the configured provider.
|
|
47
48
|
|
|
@@ -68,7 +69,7 @@ Generates a completion using the configured provider.
|
|
|
68
69
|
getConfiguration(): IIntelligenceProviderConfiguration;
|
|
69
70
|
```
|
|
70
71
|
|
|
71
|
-
Defined in: [IntelligenceTextGenerator.ts:
|
|
72
|
+
Defined in: [IntelligenceTextGenerator.ts:206](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L206)
|
|
72
73
|
|
|
73
74
|
Returns the resolved provider configuration with the API key redacted.
|
|
74
75
|
|
|
@@ -79,3 +80,25 @@ Returns the resolved provider configuration with the API key redacted.
|
|
|
79
80
|
#### Implementation of
|
|
80
81
|
|
|
81
82
|
[`IIntelligenceTextGenerator`](Interface.IIntelligenceTextGenerator).[`getConfiguration`](Interface.IIntelligenceTextGenerator#getconfiguration)
|
|
83
|
+
|
|
84
|
+
***
|
|
85
|
+
|
|
86
|
+
### onModuleInit()
|
|
87
|
+
|
|
88
|
+
```ts
|
|
89
|
+
onModuleInit(): void;
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Defined in: [IntelligenceTextGenerator.ts:86](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L86)
|
|
93
|
+
|
|
94
|
+
Eagerly resolves configuration at startup to fail fast on missing keys.
|
|
95
|
+
|
|
96
|
+
#### Returns
|
|
97
|
+
|
|
98
|
+
`void`
|
|
99
|
+
|
|
100
|
+
#### Implementation of
|
|
101
|
+
|
|
102
|
+
```ts
|
|
103
|
+
OnModuleInit.onModuleInit
|
|
104
|
+
```
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Class: IntelligenceValidationError'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Class: IntelligenceValidationError
|
|
7
|
+
|
|
8
|
+
Defined in: [errors/IntelligenceValidationError.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceValidationError.ts#L6)
|
|
9
|
+
|
|
10
|
+
Error thrown when an intelligence input validation fails.
|
|
11
|
+
|
|
12
|
+
## Extends
|
|
13
|
+
|
|
14
|
+
- `Error`
|
|
15
|
+
|
|
16
|
+
## Constructors
|
|
17
|
+
|
|
18
|
+
### Constructor
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
new IntelligenceValidationError(message): IntelligenceValidationError;
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Defined in: [errors/IntelligenceValidationError.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceValidationError.ts#L15)
|
|
25
|
+
|
|
26
|
+
#### Parameters
|
|
27
|
+
|
|
28
|
+
| Parameter | Type |
|
|
29
|
+
| ------ | ------ |
|
|
30
|
+
| `message` | `string` |
|
|
31
|
+
|
|
32
|
+
#### Returns
|
|
33
|
+
|
|
34
|
+
`IntelligenceValidationError`
|
|
35
|
+
|
|
36
|
+
#### Overrides
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
Error.constructor
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Properties
|
|
43
|
+
|
|
44
|
+
### code
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
readonly code: "INTELLIGENCE_VALIDATION" = 'INTELLIGENCE_VALIDATION';
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Defined in: [errors/IntelligenceValidationError.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceValidationError.ts#L9)
|
|
@@ -9,7 +9,7 @@ editUrl: false
|
|
|
9
9
|
function loadProviderFactory(moduleName, exportName): Promise<(model, options) => LanguageModelV2>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [providers/ProviderFactoryLoader.ts:
|
|
12
|
+
Defined in: [providers/ProviderFactoryLoader.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/ProviderFactoryLoader.ts#L17)
|
|
13
13
|
|
|
14
14
|
Dynamically loads an AI SDK provider factory and returns the exported function reference.
|
|
15
15
|
|
|
@@ -11,9 +11,11 @@ editUrl: false
|
|
|
11
11
|
| ------ | ------ |
|
|
12
12
|
| [IntelligenceCapabilityRegistrarBase](Class.IntelligenceCapabilityRegistrarBase) | Provides a reusable registration flow that allows feature modules to contribute capabilities to the global intelligence registry while keeping their implementation details private. |
|
|
13
13
|
| [IntelligenceCapabilityRegistry](Class.IntelligenceCapabilityRegistry) | Central registry responsible for resolving intelligence capabilities based on intent metadata. |
|
|
14
|
+
| [IntelligenceConfigurationError](Class.IntelligenceConfigurationError) | Error thrown when an intelligence provider configuration is invalid or missing. |
|
|
14
15
|
| [IntelligenceModule](Class.IntelligenceModule) | Core module exposing the shared intelligence infrastructure to feature modules. |
|
|
15
16
|
| [IntelligenceProviderError](Class.IntelligenceProviderError) | Error thrown when an intelligence provider call fails. |
|
|
16
17
|
| [IntelligenceTextGenerator](Class.IntelligenceTextGenerator) | Executes text completions using the configured intelligence provider. |
|
|
18
|
+
| [IntelligenceValidationError](Class.IntelligenceValidationError) | Error thrown when an intelligence input validation fails. |
|
|
17
19
|
|
|
18
20
|
## Interfaces
|
|
19
21
|
|
|
@@ -150,6 +150,38 @@ All errors are wrapped in `IntelligenceProviderError` with `provider`, `model`,
|
|
|
150
150
|
|
|
151
151
|
---
|
|
152
152
|
|
|
153
|
+
## Error Handling
|
|
154
|
+
|
|
155
|
+
The library provides three domain error classes for different failure scenarios:
|
|
156
|
+
|
|
157
|
+
| Error class | Code | When thrown |
|
|
158
|
+
| ---------------------------------- | ----------------------------- | --------------------------------------------------------------------- |
|
|
159
|
+
| `IntelligenceProviderError` | `INTELLIGENCE_PROVIDER` | Provider SDK failures during text generation |
|
|
160
|
+
| `IntelligenceValidationError` | `INTELLIGENCE_VALIDATION` | Invalid generation parameters (temperature, topP, maxOutputTokens) |
|
|
161
|
+
| `IntelligenceConfigurationError` | `INTELLIGENCE_CONFIGURATION` | Unsupported provider, missing API key, or missing SDK package |
|
|
162
|
+
|
|
163
|
+
```typescript
|
|
164
|
+
import {
|
|
165
|
+
IntelligenceProviderError,
|
|
166
|
+
IntelligenceValidationError,
|
|
167
|
+
IntelligenceConfigurationError,
|
|
168
|
+
} from '@breadstone/archipel-platform-intelligence';
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
---
|
|
172
|
+
|
|
173
|
+
## Lifecycle
|
|
174
|
+
|
|
175
|
+
`IntelligenceTextGenerator` implements `OnModuleInit` and validates the provider configuration eagerly at startup. Missing API keys or unsupported providers throw `IntelligenceConfigurationError` before the first request is processed.
|
|
176
|
+
|
|
177
|
+
---
|
|
178
|
+
|
|
179
|
+
## Capability Registry Limits
|
|
180
|
+
|
|
181
|
+
`IntelligenceCapabilityRegistry` enforces a maximum of **500** registered capabilities. Attempts to register beyond this limit are logged as warnings and silently ignored. This prevents unbounded memory growth in applications with dynamic capability registration.
|
|
182
|
+
|
|
183
|
+
---
|
|
184
|
+
|
|
153
185
|
## API Reference
|
|
154
186
|
|
|
155
187
|
See the full [API documentation](./api/) for all exported types, interfaces, and classes.
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: LoggerModule
|
|
7
7
|
|
|
8
|
-
Defined in: [LoggerModule.ts:
|
|
8
|
+
Defined in: [LoggerModule.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/LoggerModule.ts#L35)
|
|
9
9
|
|
|
10
10
|
Global logging module that configures the NestJS Logger with an application-wide log level.
|
|
11
11
|
|
|
@@ -54,6 +54,8 @@ export class PaymentService {
|
|
|
54
54
|
| --------------- | -------------------------------------------------------------- | -------- | ------- |
|
|
55
55
|
| `APP_LOG_LEVEL` | Application log level (`'debug'`, `'info'`, `'warn'`, `'error'`) | No | `warn` |
|
|
56
56
|
|
|
57
|
+
> **Startup validation:** The module validates `APP_LOG_LEVEL` at initialization. An unrecognized value triggers a warning and falls back to `warn`.
|
|
58
|
+
|
|
57
59
|
---
|
|
58
60
|
|
|
59
61
|
## Exports Summary
|
|
@@ -11,7 +11,6 @@ Represents the base class for all email delivery strategies.
|
|
|
11
11
|
|
|
12
12
|
## Extended by
|
|
13
13
|
|
|
14
|
-
- [`LogDeliveryStrategy`](Class.LogDeliveryStrategy)
|
|
15
14
|
- [`SmtpDeliveryStrategy`](Class.SmtpDeliveryStrategy)
|
|
16
15
|
- [`PostmarkDeliveryStrategy`](Class.PostmarkDeliveryStrategy)
|
|
17
16
|
- [`ResendDeliveryStrategy`](Class.ResendDeliveryStrategy)
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Class: MailDeliveryError'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Class: MailDeliveryError
|
|
7
|
+
|
|
8
|
+
Defined in: [platform-mailing/src/errors/MailDeliveryError.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/errors/MailDeliveryError.ts#L6)
|
|
9
|
+
|
|
10
|
+
Domain error thrown when email delivery fails.
|
|
11
|
+
|
|
12
|
+
## Extends
|
|
13
|
+
|
|
14
|
+
- `Error`
|
|
15
|
+
|
|
16
|
+
## Constructors
|
|
17
|
+
|
|
18
|
+
### Constructor
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
new MailDeliveryError(
|
|
22
|
+
provider,
|
|
23
|
+
message,
|
|
24
|
+
cause?): MailDeliveryError;
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Defined in: [platform-mailing/src/errors/MailDeliveryError.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/errors/MailDeliveryError.ts#L16)
|
|
28
|
+
|
|
29
|
+
#### Parameters
|
|
30
|
+
|
|
31
|
+
| Parameter | Type |
|
|
32
|
+
| ------ | ------ |
|
|
33
|
+
| `provider` | `string` |
|
|
34
|
+
| `message` | `string` |
|
|
35
|
+
| `cause?` | `unknown` |
|
|
36
|
+
|
|
37
|
+
#### Returns
|
|
38
|
+
|
|
39
|
+
`MailDeliveryError`
|
|
40
|
+
|
|
41
|
+
#### Overrides
|
|
42
|
+
|
|
43
|
+
```ts
|
|
44
|
+
Error.constructor
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Properties
|
|
48
|
+
|
|
49
|
+
### code
|
|
50
|
+
|
|
51
|
+
```ts
|
|
52
|
+
readonly code: "MAIL_DELIVERY" = 'MAIL_DELIVERY';
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Defined in: [platform-mailing/src/errors/MailDeliveryError.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/errors/MailDeliveryError.ts#L9)
|
|
56
|
+
|
|
57
|
+
***
|
|
58
|
+
|
|
59
|
+
### provider
|
|
60
|
+
|
|
61
|
+
```ts
|
|
62
|
+
readonly provider: string;
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Defined in: [platform-mailing/src/errors/MailDeliveryError.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/errors/MailDeliveryError.ts#L10)
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: MailModule
|
|
7
7
|
|
|
8
|
-
Defined in: [platform-mailing/src/MailModule.ts:
|
|
8
|
+
Defined in: [platform-mailing/src/tokens/MailModule.ts:108](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/tokens/MailModule.ts#L108)
|
|
9
9
|
|
|
10
10
|
Represents the mail module.
|
|
11
11
|
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: MailgunDeliveryStrategy
|
|
7
7
|
|
|
8
|
-
Defined in: [platform-mailing/src/services/strategies/MailgunDeliveryStrategy.ts:
|
|
8
|
+
Defined in: [platform-mailing/src/services/strategies/MailgunDeliveryStrategy.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/MailgunDeliveryStrategy.ts#L19)
|
|
9
9
|
|
|
10
10
|
Delivers emails via the Mailgun API.
|
|
11
11
|
|
|
@@ -21,7 +21,7 @@ Delivers emails via the Mailgun API.
|
|
|
21
21
|
new MailgunDeliveryStrategy(configService): MailgunDeliveryStrategy;
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
Defined in: [platform-mailing/src/services/strategies/MailgunDeliveryStrategy.ts:
|
|
24
|
+
Defined in: [platform-mailing/src/services/strategies/MailgunDeliveryStrategy.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/MailgunDeliveryStrategy.ts#L35)
|
|
25
25
|
|
|
26
26
|
Constructs a new instance of the `MailgunDeliveryStrategy` class.
|
|
27
27
|
|
|
@@ -53,7 +53,7 @@ send(
|
|
|
53
53
|
_attachments?): Promise<void>;
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
Defined in: [platform-mailing/src/services/strategies/MailgunDeliveryStrategy.ts:
|
|
56
|
+
Defined in: [platform-mailing/src/services/strategies/MailgunDeliveryStrategy.ts:60](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/MailgunDeliveryStrategy.ts#L60)
|
|
57
57
|
|
|
58
58
|
Sends an email using the Mailgun transport.
|
|
59
59
|
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: PostmarkDeliveryStrategy
|
|
7
7
|
|
|
8
|
-
Defined in: [platform-mailing/src/services/strategies/PostmarkDeliveryStrategy.ts:
|
|
8
|
+
Defined in: [platform-mailing/src/services/strategies/PostmarkDeliveryStrategy.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/PostmarkDeliveryStrategy.ts#L17)
|
|
9
9
|
|
|
10
10
|
The `PostmarkDeliveryStrategy` class.
|
|
11
11
|
|
|
@@ -21,7 +21,7 @@ The `PostmarkDeliveryStrategy` class.
|
|
|
21
21
|
new PostmarkDeliveryStrategy(configService): PostmarkDeliveryStrategy;
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
Defined in: [platform-mailing/src/services/strategies/PostmarkDeliveryStrategy.ts:
|
|
24
|
+
Defined in: [platform-mailing/src/services/strategies/PostmarkDeliveryStrategy.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/PostmarkDeliveryStrategy.ts#L32)
|
|
25
25
|
|
|
26
26
|
Constructs a new instance of the `PostmarkDeliveryStrategy` class.
|
|
27
27
|
|
|
@@ -53,7 +53,7 @@ send(
|
|
|
53
53
|
_attachments?): Promise<void>;
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
Defined in: [platform-mailing/src/services/strategies/PostmarkDeliveryStrategy.ts:
|
|
56
|
+
Defined in: [platform-mailing/src/services/strategies/PostmarkDeliveryStrategy.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/PostmarkDeliveryStrategy.ts#L52)
|
|
57
57
|
|
|
58
58
|
Sends an email using the Postmark transport.
|
|
59
59
|
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: ResendDeliveryStrategy
|
|
7
7
|
|
|
8
|
-
Defined in: [platform-mailing/src/services/strategies/ResendDeliveryStrategy.ts:
|
|
8
|
+
Defined in: [platform-mailing/src/services/strategies/ResendDeliveryStrategy.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/ResendDeliveryStrategy.ts#L17)
|
|
9
9
|
|
|
10
10
|
Delivers emails via the Resend API.
|
|
11
11
|
|
|
@@ -21,7 +21,7 @@ Delivers emails via the Resend API.
|
|
|
21
21
|
new ResendDeliveryStrategy(configService): ResendDeliveryStrategy;
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
Defined in: [platform-mailing/src/services/strategies/ResendDeliveryStrategy.ts:
|
|
24
|
+
Defined in: [platform-mailing/src/services/strategies/ResendDeliveryStrategy.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/ResendDeliveryStrategy.ts#L32)
|
|
25
25
|
|
|
26
26
|
Constructs a new instance of the `ResendDeliveryStrategy` class.
|
|
27
27
|
|
|
@@ -53,7 +53,7 @@ send(
|
|
|
53
53
|
_attachments?): Promise<void>;
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
Defined in: [platform-mailing/src/services/strategies/ResendDeliveryStrategy.ts:
|
|
56
|
+
Defined in: [platform-mailing/src/services/strategies/ResendDeliveryStrategy.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/ResendDeliveryStrategy.ts#L52)
|
|
57
57
|
|
|
58
58
|
Sends an email using the Resend transport.
|
|
59
59
|
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: SendGridDeliveryStrategy
|
|
7
7
|
|
|
8
|
-
Defined in: [platform-mailing/src/services/strategies/SendGridDeliveryStrategy.ts:
|
|
8
|
+
Defined in: [platform-mailing/src/services/strategies/SendGridDeliveryStrategy.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/SendGridDeliveryStrategy.ts#L17)
|
|
9
9
|
|
|
10
10
|
Delivers emails via the SendGrid API.
|
|
11
11
|
|
|
@@ -21,7 +21,7 @@ Delivers emails via the SendGrid API.
|
|
|
21
21
|
new SendGridDeliveryStrategy(configService): SendGridDeliveryStrategy;
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
Defined in: [platform-mailing/src/services/strategies/SendGridDeliveryStrategy.ts:
|
|
24
|
+
Defined in: [platform-mailing/src/services/strategies/SendGridDeliveryStrategy.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/SendGridDeliveryStrategy.ts#L31)
|
|
25
25
|
|
|
26
26
|
Constructs a new instance of the `SendGridDeliveryStrategy` class.
|
|
27
27
|
|
|
@@ -53,7 +53,7 @@ send(
|
|
|
53
53
|
_attachments?): Promise<void>;
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
Defined in: [platform-mailing/src/services/strategies/SendGridDeliveryStrategy.ts:
|
|
56
|
+
Defined in: [platform-mailing/src/services/strategies/SendGridDeliveryStrategy.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/SendGridDeliveryStrategy.ts#L51)
|
|
57
57
|
|
|
58
58
|
Sends an email using the SendGrid transport.
|
|
59
59
|
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: SmtpDeliveryStrategy
|
|
7
7
|
|
|
8
|
-
Defined in: [platform-mailing/src/services/strategies/SmtpDeliveryStrategy.ts:
|
|
8
|
+
Defined in: [platform-mailing/src/services/strategies/SmtpDeliveryStrategy.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/SmtpDeliveryStrategy.ts#L17)
|
|
9
9
|
|
|
10
10
|
The `SmtpDeliveryStrategy` class.
|
|
11
11
|
|
|
@@ -21,7 +21,7 @@ The `SmtpDeliveryStrategy` class.
|
|
|
21
21
|
new SmtpDeliveryStrategy(configService): SmtpDeliveryStrategy;
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
Defined in: [platform-mailing/src/services/strategies/SmtpDeliveryStrategy.ts:
|
|
24
|
+
Defined in: [platform-mailing/src/services/strategies/SmtpDeliveryStrategy.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/SmtpDeliveryStrategy.ts#L32)
|
|
25
25
|
|
|
26
26
|
Constructs a new instance of the `LogDelivery` class.
|
|
27
27
|
|
|
@@ -53,7 +53,7 @@ send(
|
|
|
53
53
|
_attachments?): Promise<void>;
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
Defined in: [platform-mailing/src/services/strategies/SmtpDeliveryStrategy.ts:
|
|
56
|
+
Defined in: [platform-mailing/src/services/strategies/SmtpDeliveryStrategy.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/SmtpDeliveryStrategy.ts#L62)
|
|
57
57
|
|
|
58
58
|
Sends an email using the SMTP transport.
|
|
59
59
|
|
|
@@ -9,11 +9,6 @@ Defined in: [platform-mailing/src/templating/strategies/abstracts/TemplateFetchS
|
|
|
9
9
|
|
|
10
10
|
Represents the base class for template fetch strategies.
|
|
11
11
|
|
|
12
|
-
## Extended by
|
|
13
|
-
|
|
14
|
-
- [`BlobTemplateFetchStrategy`](Class.BlobTemplateFetchStrategy)
|
|
15
|
-
- [`FileTemplateFetchStrategy`](Class.FileTemplateFetchStrategy)
|
|
16
|
-
|
|
17
12
|
## Constructors
|
|
18
13
|
|
|
19
14
|
### Constructor
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: SMTP\_CONFIG\_ENTRIES'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: SMTP\_CONFIG\_ENTRIES
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const SMTP_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [platform-mailing/src/smtp/env.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/smtp/env.ts#L31)
|
|
13
|
+
|
|
14
|
+
Configuration entries required by the SMTP delivery provider.
|