@breadstone/archipel-mcp 0.0.22 → 0.0.25
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/README.md +32 -13
- package/data/guides/ai-text-generation.md +16 -24
- package/data/guides/caching.md +33 -0
- package/data/guides/email-delivery.md +27 -1
- package/data/guides/email-templates.md +49 -39
- package/data/guides/esigning-integration.md +11 -5
- package/data/guides/health-indicators.md +220 -0
- package/data/guides/index.md +2 -0
- package/data/guides/queue-infrastructure.md +329 -0
- package/data/guides/telemetry-and-observability.md +20 -0
- package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +20 -0
- package/data/packages/platform-analytics/api/Class.AnalyticsHealthIndicator.md +78 -0
- package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +24 -0
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +24 -0
- package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +24 -0
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +24 -0
- package/data/packages/platform-analytics/api/index.md +1 -0
- package/data/packages/platform-analytics/index.md +25 -1
- package/data/packages/platform-authentication/api/Class.AuthenticationHealthIndicator.md +68 -0
- package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +1 -1
- package/data/packages/platform-authentication/api/index.md +2 -1
- package/data/packages/platform-authentication/index.md +25 -1
- package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +7 -7
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +2 -2
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +5 -5
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +1 -1
- package/data/packages/platform-blob-storage/api/index.md +1 -1
- package/data/packages/platform-blob-storage/index.md +19 -14
- package/data/packages/platform-caching/api/Class.MemoryLayeredCache.md +10 -10
- package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +6 -6
- package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +13 -13
- package/data/packages/platform-caching/api/Interface.ILayeredCache.md +9 -9
- package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +6 -6
- package/data/packages/platform-caching/api/Variable.CACHE_DEFAULT_TTL_MS.md +14 -0
- package/data/packages/platform-caching/api/Variable.CACHE_MAX_ENTRIES.md +14 -0
- package/data/packages/platform-caching/api/Variable.CACHE_STALE_WHILE_REVALIDATE.md +14 -0
- package/data/packages/platform-caching/api/Variable.PLATFORM_CACHING_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-caching/api/Variable.REDIS_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-caching/api/Variable.REDIS_KEY_PREFIX.md +14 -0
- package/data/packages/platform-caching/api/Variable.REDIS_TTL_SECONDS.md +14 -0
- package/data/packages/platform-caching/api/Variable.REDIS_URL.md +14 -0
- package/data/packages/platform-caching/api/index.md +13 -0
- package/data/packages/platform-caching/index.md +47 -1
- package/data/packages/platform-configuration/api/Function.createConfigKey.md +1 -1
- package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md +3 -3
- package/data/packages/platform-core/api/Function.maskSensitive.md +26 -0
- package/data/packages/platform-core/api/Function.maskSensitiveFields.md +26 -0
- package/data/packages/platform-core/api/index.md +2 -0
- package/data/packages/platform-core/index.md +11 -0
- package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +8 -6
- package/data/packages/platform-database/api/Class.DatabaseModule.md +3 -3
- package/data/packages/platform-database/api/Class.RepositoryBase.md +20 -20
- package/data/packages/platform-database/api/Function.paginator.md +1 -1
- package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +3 -3
- package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +1 -1
- package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +1 -1
- package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +1 -1
- package/data/packages/platform-database/api/Variable.DATABASE_MODULE_CONFIG.md +1 -1
- package/data/packages/platform-database/index.md +17 -5
- package/data/packages/platform-documents/api/Class.DocumentEngine.md +9 -5
- package/data/packages/platform-documents/index.md +1 -1
- package/data/packages/platform-esigning/api/Class.AdobeSignEsigningProvider.md +24 -0
- package/data/packages/platform-esigning/api/Class.DocuSignEsigningProvider.md +24 -0
- package/data/packages/platform-esigning/api/Class.DropboxSignEsigningProvider.md +24 -0
- package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +20 -0
- package/data/packages/platform-esigning/api/Class.EsigningHealthIndicator.md +78 -0
- package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +24 -0
- package/data/packages/platform-esigning/api/index.md +1 -0
- package/data/packages/platform-esigning/index.md +26 -2
- package/data/packages/platform-health/api/Class.HealthModule.md +42 -0
- package/data/packages/platform-health/api/Class.HealthOrchestrator.md +64 -0
- package/data/packages/platform-health/api/Interface.IHealthCheckResult.md +46 -0
- package/data/packages/platform-health/api/Interface.IHealthIndicator.md +41 -0
- package/data/packages/platform-health/api/Variable.HEALTH_INDICATORS_TOKEN.md +14 -0
- package/data/packages/platform-health/api/index.md +26 -0
- package/data/packages/platform-health/index.md +19 -8
- package/data/packages/platform-intelligence/api/Class.IntelligenceHealthIndicator.md +78 -0
- package/data/packages/platform-intelligence/api/index.md +1 -0
- package/data/packages/platform-intelligence/index.md +24 -1
- package/data/packages/platform-logging/api/Class.ContextLogger.md +152 -0
- package/data/packages/platform-logging/api/Class.LoggerModule.md +8 -2
- package/data/packages/platform-logging/api/Class.RequestContextStore.md +90 -0
- package/data/packages/platform-logging/api/Class.RequestIdMiddleware.md +68 -0
- package/data/packages/platform-logging/api/Interface.IRequestContext.md +34 -0
- package/data/packages/platform-logging/api/Variable.REQUEST_ID_HEADER.md +14 -0
- package/data/packages/platform-logging/api/index.md +11 -1
- package/data/packages/platform-logging/index.md +89 -7
- package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +5 -5
- package/data/packages/platform-mailing/api/Class.MailModule.md +28 -1
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +49 -16
- package/data/packages/platform-mailing/api/Class.SmtpConnectionVerifier.md +84 -0
- package/data/packages/platform-mailing/api/Interface.IMailModuleOptions.md +36 -0
- package/data/packages/platform-mailing/api/index.md +3 -1
- package/data/packages/platform-mailing/index.md +64 -8
- package/data/packages/platform-mapping/api/Class.MappingBuilder.md +110 -0
- package/data/packages/platform-mapping/api/Class.MappingError.md +56 -0
- package/data/packages/platform-mapping/api/Class.MappingModule.md +46 -0
- package/data/packages/platform-mapping/api/Class.MappingNotRegisteredError.md +52 -0
- package/data/packages/platform-mapping/api/Class.MappingProfileBase.md +52 -0
- package/data/packages/platform-mapping/api/Class.MappingService.md +284 -0
- package/data/packages/platform-mapping/api/Class.TypeMappingNotRegisteredError.md +53 -0
- package/data/packages/platform-mapping/api/Function.createMappingKey.md +39 -0
- package/data/packages/platform-mapping/api/Interface.IMappingBuilder.md +76 -0
- package/data/packages/platform-mapping/api/Interface.IMappingKey.md +58 -0
- package/data/packages/platform-mapping/api/Interface.IMappingProfile.md +32 -0
- package/data/packages/platform-mapping/api/TypeAlias.Constructor.md +28 -0
- package/data/packages/platform-mapping/api/index.md +38 -0
- package/data/packages/platform-mapping/index.md +1 -1
- package/data/packages/platform-mcp/api/Class.McpHealthIndicator.md +78 -0
- package/data/packages/platform-mcp/api/index.md +1 -0
- package/data/packages/platform-mcp/index.md +24 -1
- package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +2 -2
- package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +2 -2
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +24 -0
- package/data/packages/platform-payments/api/Class.MollieClient.md +24 -0
- package/data/packages/platform-payments/api/Class.PaddleClient.md +24 -0
- package/data/packages/platform-payments/api/Class.PaymentClientPort.md +20 -0
- package/data/packages/platform-payments/api/Class.PaymentHealthIndicator.md +78 -0
- package/data/packages/platform-payments/api/Class.StripeClient.md +28 -4
- package/data/packages/platform-payments/api/index.md +1 -0
- package/data/packages/platform-payments/index.md +26 -2
- package/data/packages/platform-queue/api/Class.AzureQueue.md +221 -0
- package/data/packages/platform-queue/api/Class.BullMqQueue.md +220 -0
- package/data/packages/platform-queue/api/Class.MemoryQueue.md +194 -0
- package/data/packages/platform-queue/api/Class.QueueError.md +51 -0
- package/data/packages/platform-queue/api/Class.QueueHealthIndicator.md +68 -0
- package/data/packages/platform-queue/api/Class.QueueJobNotFoundError.md +43 -0
- package/data/packages/platform-queue/api/Class.QueueJobStateError.md +48 -0
- package/data/packages/platform-queue/api/Class.QueueValidationError.md +43 -0
- package/data/packages/platform-queue/api/Interface.IAzureQueueOptions.md +48 -0
- package/data/packages/platform-queue/api/Interface.IBullMqQueueOptions.md +45 -0
- package/data/packages/platform-queue/api/Interface.IMemoryQueueOptions.md +32 -0
- package/data/packages/platform-queue/api/Interface.IQueue.md +173 -0
- package/data/packages/platform-queue/api/Interface.IQueueJob.md +139 -0
- package/data/packages/platform-queue/api/TypeAlias.QueueJobStatus.md +14 -0
- package/data/packages/platform-queue/api/Variable.AZURE_CONFIG_ENTRIES.md +17 -0
- package/data/packages/platform-queue/api/Variable.AZURE_CONNECTION_STRING.md +14 -0
- package/data/packages/platform-queue/api/Variable.AZURE_RECEIVE_WAIT_MS.md +21 -0
- package/data/packages/platform-queue/api/Variable.BULLMQ_CONFIG_ENTRIES.md +17 -0
- package/data/packages/platform-queue/api/Variable.BULLMQ_PREFIX.md +18 -0
- package/data/packages/platform-queue/api/Variable.BULLMQ_REDIS_URL.md +21 -0
- package/data/packages/platform-queue/api/Variable.PLATFORM_QUEUE_CONFIG_ENTRIES.md +17 -0
- package/data/packages/platform-queue/api/Variable.QUEUE_JOB_STATUS.md +30 -0
- package/data/packages/platform-queue/api/Variable.QUEUE_MAX_JOBS.md +21 -0
- package/data/packages/platform-queue/api/index.md +49 -0
- package/data/packages/platform-queue/index.md +168 -0
- package/data/packages/platform-resources/api/Class.BlobResourceStrategy.md +195 -0
- package/data/packages/platform-resources/api/Class.EmbeddedResourceStrategy.md +215 -0
- package/data/packages/platform-resources/api/Class.FileResourceStrategy.md +190 -0
- package/data/packages/platform-resources/api/Class.ResourceManager.md +477 -0
- package/data/packages/platform-resources/api/Class.ResourceModule.md +46 -0
- package/data/packages/platform-resources/api/Class.ResourceNotFoundError.md +60 -0
- package/data/packages/platform-resources/api/Interface.IBlobResourceStrategyConfig.md +28 -0
- package/data/packages/platform-resources/api/Interface.IBlobServiceAdapter.md +40 -0
- package/data/packages/platform-resources/api/Interface.IFileResourceStrategyConfig.md +72 -0
- package/data/packages/platform-resources/api/Interface.IResourceManagerConfig.md +89 -0
- package/data/packages/platform-resources/api/Interface.IResourceMetadata.md +94 -0
- package/data/packages/platform-resources/api/Interface.IResourceResult.md +34 -0
- package/data/packages/platform-resources/api/Interface.IResourceStrategy.md +134 -0
- package/data/packages/platform-resources/api/index.md +29 -0
- package/data/packages/platform-resources/index.md +1 -1
- package/data/packages/platform-telemetry/api/Class.OtelSdkHolder.md +21 -3
- package/data/packages/platform-telemetry/api/Class.TelemetryHealthIndicator.md +78 -0
- package/data/packages/platform-telemetry/api/index.md +1 -0
- package/data/packages/platform-telemetry/index.md +25 -1
- package/data/patterns/config-pattern.md +5 -3
- package/package.json +2 -2
- package/src/tools/registerGetConfigPatternTool.js +1 -1
- package/src/tools/registerGetDtoPatternTool.js +1 -1
- package/src/tools/registerGetErrorHandlingPatternTool.js +1 -1
- package/src/tools/registerGetGuardPatternTool.js +1 -1
- package/src/tools/registerGetMappingPatternTool.js +1 -1
- package/src/tools/registerGetModulePatternTool.js +1 -1
- package/src/tools/registerGetQueryPatternTool.js +1 -1
- package/src/tools/registerGetRepositoryPatternTool.js +1 -1
- package/src/tools/registerGetTestingPatternTool.js +1 -1
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Class: TelemetryHealthIndicator'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Class: TelemetryHealthIndicator
|
|
7
|
+
|
|
8
|
+
Defined in: health/TelemetryHealthIndicator.ts:17
|
|
9
|
+
|
|
10
|
+
Health indicator for the telemetry infrastructure.
|
|
11
|
+
Checks whether the OpenTelemetry SDK has been initialized via [OtelSdkHolder](Class.OtelSdkHolder).
|
|
12
|
+
|
|
13
|
+
## Implements
|
|
14
|
+
|
|
15
|
+
- `IHealthIndicator`
|
|
16
|
+
|
|
17
|
+
## Constructors
|
|
18
|
+
|
|
19
|
+
### Constructor
|
|
20
|
+
|
|
21
|
+
```ts
|
|
22
|
+
new TelemetryHealthIndicator(sdkHolder?): TelemetryHealthIndicator;
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Defined in: health/TelemetryHealthIndicator.ts:26
|
|
26
|
+
|
|
27
|
+
#### Parameters
|
|
28
|
+
|
|
29
|
+
| Parameter | Type |
|
|
30
|
+
| ------ | ------ |
|
|
31
|
+
| `sdkHolder?` | [`OtelSdkHolder`](Class.OtelSdkHolder) |
|
|
32
|
+
|
|
33
|
+
#### Returns
|
|
34
|
+
|
|
35
|
+
`TelemetryHealthIndicator`
|
|
36
|
+
|
|
37
|
+
## Properties
|
|
38
|
+
|
|
39
|
+
### key
|
|
40
|
+
|
|
41
|
+
```ts
|
|
42
|
+
readonly key: string = 'telemetry';
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Defined in: health/TelemetryHealthIndicator.ts:34
|
|
46
|
+
|
|
47
|
+
Unique key identifying the indicator
|
|
48
|
+
|
|
49
|
+
#### Implementation of
|
|
50
|
+
|
|
51
|
+
```ts
|
|
52
|
+
IHealthIndicator.key
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Methods
|
|
56
|
+
|
|
57
|
+
### check()
|
|
58
|
+
|
|
59
|
+
```ts
|
|
60
|
+
check(): HealthIndicatorResult<string>;
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Defined in: health/TelemetryHealthIndicator.ts:47
|
|
64
|
+
|
|
65
|
+
Checks whether the OpenTelemetry SDK has been initialized.
|
|
66
|
+
Returns disabled status when no SDK holder is configured.
|
|
67
|
+
|
|
68
|
+
#### Returns
|
|
69
|
+
|
|
70
|
+
`HealthIndicatorResult`\<`string`\>
|
|
71
|
+
|
|
72
|
+
The health indicator result.
|
|
73
|
+
|
|
74
|
+
#### Implementation of
|
|
75
|
+
|
|
76
|
+
```ts
|
|
77
|
+
IHealthIndicator.check
|
|
78
|
+
```
|
|
@@ -14,6 +14,7 @@ editUrl: false
|
|
|
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). |
|
|
16
16
|
| [TelemetryFacade](Class.TelemetryFacade) | - |
|
|
17
|
+
| [TelemetryHealthIndicator](Class.TelemetryHealthIndicator) | Health indicator for the telemetry infrastructure. Checks whether the OpenTelemetry SDK has been initialized via [OtelSdkHolder](Class.OtelSdkHolder). |
|
|
17
18
|
| [TelemetryLoggerService](Class.TelemetryLoggerService) | - |
|
|
18
19
|
| [TelemetryModule](Class.TelemetryModule) | - |
|
|
19
20
|
| [TelemetryRuleEngine](Class.TelemetryRuleEngine) | - |
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: platform-telemetry
|
|
3
3
|
description: OpenTelemetry integration with tracing, metrics, and graceful no-op fallback.
|
|
4
4
|
order: 11
|
|
5
|
-
tags: [telemetry, opentelemetry, tracing, metrics, observability]
|
|
5
|
+
tags: [telemetry, opentelemetry, tracing, metrics, observability, health]
|
|
6
6
|
package: '@breadstone/archipel-platform-telemetry'
|
|
7
7
|
---
|
|
8
8
|
|
|
@@ -219,6 +219,29 @@ When `enabled: false` or when the OTEL SDK fails to initialize:
|
|
|
219
219
|
|
|
220
220
|
---
|
|
221
221
|
|
|
222
|
+
## Health Check
|
|
223
|
+
|
|
224
|
+
The `TelemetryHealthIndicator` verifies that the `OtelSdkHolder` is injected. If the OpenTelemetry SDK is not initialized, it reports `disabled: true`. Import it from the `/health` subpath:
|
|
225
|
+
|
|
226
|
+
```typescript
|
|
227
|
+
import { TelemetryHealthIndicator } from '@breadstone/archipel-platform-telemetry/health';
|
|
228
|
+
import { HealthModule } from '@breadstone/archipel-platform-health';
|
|
229
|
+
|
|
230
|
+
@Module({
|
|
231
|
+
imports: [
|
|
232
|
+
TelemetryModule,
|
|
233
|
+
HealthModule.withIndicators([TelemetryHealthIndicator]),
|
|
234
|
+
],
|
|
235
|
+
})
|
|
236
|
+
export class AppModule {}
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
| Key | Check | Dependencies |
|
|
240
|
+
| --- | ----- | ------------ |
|
|
241
|
+
| `telemetry` | `up` if `OtelSdkHolder` injected, else `disabled` | `@Optional() OtelSdkHolder` |
|
|
242
|
+
|
|
243
|
+
---
|
|
244
|
+
|
|
222
245
|
## Exports Summary
|
|
223
246
|
|
|
224
247
|
| Export | Type | Description |
|
|
@@ -234,3 +257,4 @@ When `enabled: false` or when the OTEL SDK fails to initialize:
|
|
|
234
257
|
| `TELEMETRY_ENABLED` | Token | Boolean enabled flag |
|
|
235
258
|
| `TELEMETRY_OPTIONS` | Token | Configuration options |
|
|
236
259
|
| `TELEMETRY_SHUTDOWN` | Token | Shutdown hook |
|
|
260
|
+
| `TelemetryHealthIndicator` | Health | Telemetry readiness check (`/health` subpath) |
|
|
@@ -18,7 +18,7 @@ Azure App Configuration, etc.).
|
|
|
18
18
|
|
|
19
19
|
## Core Types
|
|
20
20
|
|
|
21
|
-
### IConfigKey<TType
|
|
21
|
+
### `IConfigKey<TType>`
|
|
22
22
|
|
|
23
23
|
```typescript
|
|
24
24
|
export interface IConfigKey<TType = unknown> {
|
|
@@ -27,7 +27,7 @@ export interface IConfigKey<TType = unknown> {
|
|
|
27
27
|
}
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
### createConfigKey<TType
|
|
30
|
+
### `createConfigKey<TType>`
|
|
31
31
|
|
|
32
32
|
```typescript
|
|
33
33
|
import { createConfigKey } from '@breadstone/archipel-platform-core';
|
|
@@ -194,8 +194,10 @@ Implementations can read from environment variables, Azure App Configuration, Co
|
|
|
194
194
|
|--------|--------|-------------|
|
|
195
195
|
| platform-core | APP_, NODE_ENV, INTELLIGENCE_ | APP_URL, APP_PORT, APP_VERSION, INTELLIGENCE_MODEL |
|
|
196
196
|
| platform-authentication | AUTH_ | AUTH_JWT_SECRET, AUTH_JWT_EXPIRES_IN |
|
|
197
|
-
| platform-payments | STRIPE_ | STRIPE_SECRET_KEY, STRIPE_WEBHOOK_SECRET |
|
|
197
|
+
| platform-payments | STRIPE_, PADDLE_, LEMONSQUEEZY_, MOLLIE_ | STRIPE_SECRET_KEY, STRIPE_WEBHOOK_SECRET |
|
|
198
198
|
| platform-openapi | SWAGGER_ | SWAGGER_CONTACT_NAME, SWAGGER_CONTACT_URL |
|
|
199
|
+
| platform-caching | CACHE_, REDIS_ | CACHE_DEFAULT_TTL_MS, CACHE_MAX_ENTRIES, REDIS_URL |
|
|
200
|
+
| platform-logging | APP_LOG_LEVEL | APP_LOG_LEVEL |
|
|
199
201
|
|
|
200
202
|
## Rules
|
|
201
203
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@breadstone/archipel-mcp",
|
|
3
|
-
"version": "0.0.
|
|
4
|
-
"description": "MCP server providing Archipel platform knowledge
|
|
3
|
+
"version": "0.0.25",
|
|
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",
|
|
7
7
|
"bin": "./src/main.js",
|
|
@@ -5,7 +5,7 @@ exports.registerGetConfigPatternTool = registerGetConfigPatternTool;
|
|
|
5
5
|
* Registers the get-config-pattern tool on the MCP server.
|
|
6
6
|
*/
|
|
7
7
|
function registerGetConfigPatternTool(server, patternsLoader) {
|
|
8
|
-
server.tool('get-config-pattern', 'Returns the Archipel configuration pattern
|
|
8
|
+
server.tool('get-config-pattern', 'Returns the Archipel configuration pattern - typed config keys (createConfigKey), ConfigRegistry, ConfigService, env.ts conventions, and ConfigModule integration.', {}, async () => {
|
|
9
9
|
const pattern = patternsLoader.patterns.get('config-pattern');
|
|
10
10
|
const text = pattern?.content ?? 'Config pattern documentation not available.';
|
|
11
11
|
return {
|
|
@@ -5,7 +5,7 @@ exports.registerGetDtoPatternTool = registerGetDtoPatternTool;
|
|
|
5
5
|
* Registers the get-dto-pattern tool on the MCP server.
|
|
6
6
|
*/
|
|
7
7
|
function registerGetDtoPatternTool(server, patternsLoader) {
|
|
8
|
-
server.tool('get-dto-pattern', 'Returns the Archipel DTO & validation pattern
|
|
8
|
+
server.tool('get-dto-pattern', 'Returns the Archipel DTO & validation pattern - Request/Response DTOs, class-validator decorators, cross-field validation, query parameter DTOs, OpenAPI integration, and naming conventions.', {}, async () => {
|
|
9
9
|
const pattern = patternsLoader.patterns.get('dto-pattern');
|
|
10
10
|
const text = pattern?.content ?? 'DTO pattern documentation not available.';
|
|
11
11
|
return {
|
|
@@ -5,7 +5,7 @@ exports.registerGetErrorHandlingPatternTool = registerGetErrorHandlingPatternToo
|
|
|
5
5
|
* Registers the get-error-handling-pattern tool on the MCP server.
|
|
6
6
|
*/
|
|
7
7
|
function registerGetErrorHandlingPatternTool(server, patternsLoader) {
|
|
8
|
-
server.tool('get-error-handling-pattern', 'Returns the Archipel error handling pattern
|
|
8
|
+
server.tool('get-error-handling-pattern', 'Returns the Archipel error handling pattern - domain errors, RepositoryError, exception filters, and structured error response envelopes.', {}, async () => {
|
|
9
9
|
const pattern = patternsLoader.patterns.get('error-handling-pattern');
|
|
10
10
|
const text = pattern?.content ?? 'Error handling pattern documentation not available.';
|
|
11
11
|
return {
|
|
@@ -5,7 +5,7 @@ exports.registerGetGuardPatternTool = registerGetGuardPatternTool;
|
|
|
5
5
|
* Registers the get-guard-pattern tool on the MCP server.
|
|
6
6
|
*/
|
|
7
7
|
function registerGetGuardPatternTool(server, patternsLoader) {
|
|
8
|
-
server.tool('get-guard-pattern', 'Returns the Archipel guard & interceptor pattern
|
|
8
|
+
server.tool('get-guard-pattern', 'Returns the Archipel guard & interceptor pattern - metadata decorators, FeatureGuard, RolesGuard, FeatureUsageInterceptor, and the full decorator-guard-interceptor trio.', {}, async () => {
|
|
9
9
|
const pattern = patternsLoader.patterns.get('guard-pattern');
|
|
10
10
|
const text = pattern?.content ?? 'Guard pattern documentation not available.';
|
|
11
11
|
return {
|
|
@@ -7,7 +7,7 @@ const mappingPatternGenerator_1 = require("../generators/mappingPatternGenerator
|
|
|
7
7
|
* Registers the get-mapping-pattern tool on the MCP server.
|
|
8
8
|
*/
|
|
9
9
|
function registerGetMappingPatternTool(server, patternsLoader) {
|
|
10
|
-
server.tool('get-mapping-pattern', 'Returns the Archipel mapping pattern
|
|
10
|
+
server.tool('get-mapping-pattern', 'Returns the Archipel mapping pattern - branded type-safe mapping keys, MappingProfileBase, MappingService, and MappingModule registration. Optionally tailored to a specific entity and response class.', {
|
|
11
11
|
entityName: zod_1.z
|
|
12
12
|
.string()
|
|
13
13
|
.optional()
|
|
@@ -7,7 +7,7 @@ const modulePatternGenerator_1 = require("../generators/modulePatternGenerator")
|
|
|
7
7
|
* Registers the get-module-pattern tool on the MCP server.
|
|
8
8
|
*/
|
|
9
9
|
function registerGetModulePatternTool(server, patternsLoader) {
|
|
10
|
-
server.tool('get-module-pattern', 'Returns the Archipel NestJS dynamic module pattern
|
|
10
|
+
server.tool('get-module-pattern', 'Returns the Archipel NestJS dynamic module pattern - register(), port/adapter injection, ConfigModule integration. Optionally tailored with module name and port definitions.', {
|
|
11
11
|
moduleName: zod_1.z
|
|
12
12
|
.string()
|
|
13
13
|
.optional()
|
|
@@ -7,7 +7,7 @@ const queryPatternGenerator_1 = require("../generators/queryPatternGenerator");
|
|
|
7
7
|
* Registers the get-query-pattern tool on the MCP server.
|
|
8
8
|
*/
|
|
9
9
|
function registerGetQueryPatternTool(server, patternsLoader) {
|
|
10
|
-
server.tool('get-query-pattern', 'Returns the Archipel query pattern documentation
|
|
10
|
+
server.tool('get-query-pattern', 'Returns the Archipel query pattern documentation - interfaces, factories, rules, and examples. Optionally tailored to a specific Prisma model.', {
|
|
11
11
|
modelName: zod_1.z
|
|
12
12
|
.string()
|
|
13
13
|
.optional()
|
|
@@ -7,7 +7,7 @@ const repositoryPatternGenerator_1 = require("../generators/repositoryPatternGen
|
|
|
7
7
|
* Registers the get-repository-pattern tool on the MCP server.
|
|
8
8
|
*/
|
|
9
9
|
function registerGetRepositoryPatternTool(server, patternsLoader) {
|
|
10
|
-
server.tool('get-repository-pattern', 'Returns the Archipel repository class pattern
|
|
10
|
+
server.tool('get-repository-pattern', 'Returns the Archipel repository class pattern - how to create a RepositoryBase subclass with correct generics, module registration, and service injection. Optionally tailored to a specific Prisma model.', {
|
|
11
11
|
modelName: zod_1.z
|
|
12
12
|
.string()
|
|
13
13
|
.optional()
|
|
@@ -5,7 +5,7 @@ exports.registerGetTestingPatternTool = registerGetTestingPatternTool;
|
|
|
5
5
|
* Registers the get-testing-pattern tool on the MCP server.
|
|
6
6
|
*/
|
|
7
7
|
function registerGetTestingPatternTool(server, patternsLoader) {
|
|
8
|
-
server.tool('get-testing-pattern', 'Returns the Archipel testing pattern
|
|
8
|
+
server.tool('get-testing-pattern', 'Returns the Archipel testing pattern - Vitest conventions, mocking patterns for repositories/services/delegates, AAA structure, and test naming conventions.', {}, async () => {
|
|
9
9
|
const pattern = patternsLoader.patterns.get('testing-pattern');
|
|
10
10
|
const text = pattern?.content ?? 'Testing pattern documentation not available.';
|
|
11
11
|
return {
|