@breadstone/archipel-mcp 0.0.23 → 0.0.26
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/caching.md +33 -0
- package/data/guides/email-delivery.md +27 -1
- 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/index.md +1 -0
- 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 +10 -10
- 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 +113 -49
- package/data/packages/platform-database/api/Class.RepositoryBase2.md +171 -0
- package/data/packages/platform-database/api/Function.aggregate.md +33 -0
- package/data/packages/platform-database/api/Function.aggregateRaw.md +34 -0
- package/data/packages/platform-database/api/Function.count.md +33 -0
- package/data/packages/platform-database/api/Function.create.md +33 -0
- package/data/packages/platform-database/api/Function.createMany.md +33 -0
- package/data/packages/platform-database/api/Function.createManyAndReturn.md +35 -0
- package/data/packages/platform-database/api/Function.findFirst.md +35 -0
- package/data/packages/platform-database/api/Function.findFirstOrThrow.md +34 -0
- package/data/packages/platform-database/api/Function.findMany.md +32 -0
- package/data/packages/platform-database/api/Function.findManyPaged.md +34 -0
- package/data/packages/platform-database/api/Function.findRaw.md +34 -0
- package/data/packages/platform-database/api/Function.findUnique.md +32 -0
- package/data/packages/platform-database/api/Function.findUniqueOrThrow.md +34 -0
- package/data/packages/platform-database/api/Function.groupBy.md +33 -0
- package/data/packages/platform-database/api/Function.paginator.md +1 -1
- package/data/packages/platform-database/api/Function.pipe.md +34 -0
- package/data/packages/platform-database/api/Function.pipeAll.md +35 -0
- package/data/packages/platform-database/api/Function.query2.md +35 -0
- package/data/packages/platform-database/api/Function.remove.md +33 -0
- package/data/packages/platform-database/api/Function.removeMany.md +33 -0
- package/data/packages/platform-database/api/Function.update.md +33 -0
- package/data/packages/platform-database/api/Function.updateMany.md +33 -0
- package/data/packages/platform-database/api/Function.updateManyAndReturn.md +35 -0
- package/data/packages/platform-database/api/Function.upsert.md +33 -0
- package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +3 -3
- package/data/packages/platform-database/api/Interface.IRepositoryQuery2.md +45 -0
- package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +1 -1
- package/data/packages/platform-database/api/TypeAlias.DelegateOperations.md +29 -0
- 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/TypeAlias.RepositoryOperationsAll.md +19 -0
- package/data/packages/platform-database/api/TypeAlias.RepositoryOperationsBase.md +34 -0
- package/data/packages/platform-database/api/Variable.DATABASE_MODULE_CONFIG.md +1 -1
- package/data/packages/platform-database/api/index.md +29 -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 +18 -7
- 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-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-telemetry/api/Class.OtelSdkHolder.md +20 -2
- 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 +3 -1
- package/package.json +1 -1
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IResourceManagerConfig'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IResourceManagerConfig
|
|
7
|
+
|
|
8
|
+
Defined in: [ResourceManager.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L16)
|
|
9
|
+
|
|
10
|
+
Configuration for the ResourceManager.
|
|
11
|
+
|
|
12
|
+
## Properties
|
|
13
|
+
|
|
14
|
+
### cache?
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
optional cache?: ILayeredCache<string, IResourceResult>;
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: [ResourceManager.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L26)
|
|
21
|
+
|
|
22
|
+
Optional cache for loaded resources.
|
|
23
|
+
|
|
24
|
+
***
|
|
25
|
+
|
|
26
|
+
### cacheTtl?
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
optional cacheTtl?: number;
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Defined in: [ResourceManager.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L32)
|
|
33
|
+
|
|
34
|
+
Cache TTL in seconds.
|
|
35
|
+
|
|
36
|
+
#### Default
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
3600 (1 hour)
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
***
|
|
43
|
+
|
|
44
|
+
### debug?
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
optional debug?: boolean;
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Defined in: [ResourceManager.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L38)
|
|
51
|
+
|
|
52
|
+
Enable debug logging.
|
|
53
|
+
|
|
54
|
+
#### Default
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
false
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
***
|
|
61
|
+
|
|
62
|
+
### strategies
|
|
63
|
+
|
|
64
|
+
```ts
|
|
65
|
+
strategies: IResourceStrategy[];
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Defined in: [ResourceManager.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L21)
|
|
69
|
+
|
|
70
|
+
Resource loading strategies in priority order.
|
|
71
|
+
First strategy that finds the resource wins.
|
|
72
|
+
|
|
73
|
+
***
|
|
74
|
+
|
|
75
|
+
### strategyTimeoutMs?
|
|
76
|
+
|
|
77
|
+
```ts
|
|
78
|
+
optional strategyTimeoutMs?: number;
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Defined in: [ResourceManager.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L44)
|
|
82
|
+
|
|
83
|
+
Timeout in milliseconds for a single async strategy load.
|
|
84
|
+
|
|
85
|
+
#### Default
|
|
86
|
+
|
|
87
|
+
```ts
|
|
88
|
+
30000 (30 seconds)
|
|
89
|
+
```
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IResourceMetadata'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IResourceMetadata
|
|
7
|
+
|
|
8
|
+
Defined in: [types/IResourceMetadata.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/types/IResourceMetadata.ts#L6)
|
|
9
|
+
|
|
10
|
+
Metadata about a resource.
|
|
11
|
+
|
|
12
|
+
## Properties
|
|
13
|
+
|
|
14
|
+
### cachedAt?
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
optional cachedAt?: Date;
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: [types/IResourceMetadata.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/types/IResourceMetadata.ts#L40)
|
|
21
|
+
|
|
22
|
+
When this resource was cached (if applicable).
|
|
23
|
+
|
|
24
|
+
***
|
|
25
|
+
|
|
26
|
+
### encoding?
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
optional encoding?: BufferEncoding;
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Defined in: [types/IResourceMetadata.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/types/IResourceMetadata.ts#L30)
|
|
33
|
+
|
|
34
|
+
The encoding of the resource (if applicable).
|
|
35
|
+
|
|
36
|
+
***
|
|
37
|
+
|
|
38
|
+
### key
|
|
39
|
+
|
|
40
|
+
```ts
|
|
41
|
+
key: string;
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Defined in: [types/IResourceMetadata.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/types/IResourceMetadata.ts#L10)
|
|
45
|
+
|
|
46
|
+
The resource key/identifier.
|
|
47
|
+
|
|
48
|
+
***
|
|
49
|
+
|
|
50
|
+
### mimeType
|
|
51
|
+
|
|
52
|
+
```ts
|
|
53
|
+
mimeType: string;
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Defined in: [types/IResourceMetadata.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/types/IResourceMetadata.ts#L20)
|
|
57
|
+
|
|
58
|
+
The MIME type of the resource.
|
|
59
|
+
|
|
60
|
+
***
|
|
61
|
+
|
|
62
|
+
### path
|
|
63
|
+
|
|
64
|
+
```ts
|
|
65
|
+
path: string;
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Defined in: [types/IResourceMetadata.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/types/IResourceMetadata.ts#L15)
|
|
69
|
+
|
|
70
|
+
The full path of the resource.
|
|
71
|
+
|
|
72
|
+
***
|
|
73
|
+
|
|
74
|
+
### size
|
|
75
|
+
|
|
76
|
+
```ts
|
|
77
|
+
size: number;
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Defined in: [types/IResourceMetadata.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/types/IResourceMetadata.ts#L25)
|
|
81
|
+
|
|
82
|
+
The size of the resource in bytes.
|
|
83
|
+
|
|
84
|
+
***
|
|
85
|
+
|
|
86
|
+
### source
|
|
87
|
+
|
|
88
|
+
```ts
|
|
89
|
+
source: string;
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Defined in: [types/IResourceMetadata.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/types/IResourceMetadata.ts#L35)
|
|
93
|
+
|
|
94
|
+
The source strategy that resolved this resource.
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IResourceResult'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IResourceResult
|
|
7
|
+
|
|
8
|
+
Defined in: [types/IResourceResult.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/types/IResourceResult.ts#L8)
|
|
9
|
+
|
|
10
|
+
Result of loading a resource.
|
|
11
|
+
|
|
12
|
+
## Properties
|
|
13
|
+
|
|
14
|
+
### content
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
content: Buffer;
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: [types/IResourceResult.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/types/IResourceResult.ts#L12)
|
|
21
|
+
|
|
22
|
+
The resource content as a Buffer.
|
|
23
|
+
|
|
24
|
+
***
|
|
25
|
+
|
|
26
|
+
### metadata
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
metadata: IResourceMetadata;
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Defined in: [types/IResourceResult.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/types/IResourceResult.ts#L17)
|
|
33
|
+
|
|
34
|
+
Metadata about the resource.
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IResourceStrategy'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IResourceStrategy
|
|
7
|
+
|
|
8
|
+
Defined in: [strategies/abstracts/IResourceStrategy.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/abstracts/IResourceStrategy.ts#L8)
|
|
9
|
+
|
|
10
|
+
Strategy for loading resources from a specific source.
|
|
11
|
+
|
|
12
|
+
## Properties
|
|
13
|
+
|
|
14
|
+
### name
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
readonly name: string;
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: [strategies/abstracts/IResourceStrategy.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/abstracts/IResourceStrategy.ts#L12)
|
|
21
|
+
|
|
22
|
+
The unique name of this strategy.
|
|
23
|
+
|
|
24
|
+
## Methods
|
|
25
|
+
|
|
26
|
+
### exists()
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
exists(key): boolean;
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Defined in: [strategies/abstracts/IResourceStrategy.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/abstracts/IResourceStrategy.ts#L36)
|
|
33
|
+
|
|
34
|
+
Checks if a resource exists without loading it.
|
|
35
|
+
|
|
36
|
+
#### Parameters
|
|
37
|
+
|
|
38
|
+
| Parameter | Type | Description |
|
|
39
|
+
| ------ | ------ | ------ |
|
|
40
|
+
| `key` | `string` | The resource key/identifier |
|
|
41
|
+
|
|
42
|
+
#### Returns
|
|
43
|
+
|
|
44
|
+
`boolean`
|
|
45
|
+
|
|
46
|
+
True if the resource exists
|
|
47
|
+
|
|
48
|
+
***
|
|
49
|
+
|
|
50
|
+
### existsAsync()
|
|
51
|
+
|
|
52
|
+
```ts
|
|
53
|
+
existsAsync(key): Promise<boolean>;
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Defined in: [strategies/abstracts/IResourceStrategy.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/abstracts/IResourceStrategy.ts#L44)
|
|
57
|
+
|
|
58
|
+
Checks if a resource exists without loading it (asynchronous).
|
|
59
|
+
|
|
60
|
+
#### Parameters
|
|
61
|
+
|
|
62
|
+
| Parameter | Type | Description |
|
|
63
|
+
| ------ | ------ | ------ |
|
|
64
|
+
| `key` | `string` | The resource key/identifier |
|
|
65
|
+
|
|
66
|
+
#### Returns
|
|
67
|
+
|
|
68
|
+
`Promise`\<`boolean`\>
|
|
69
|
+
|
|
70
|
+
Promise resolving to true if the resource exists
|
|
71
|
+
|
|
72
|
+
***
|
|
73
|
+
|
|
74
|
+
### load()
|
|
75
|
+
|
|
76
|
+
```ts
|
|
77
|
+
load(key): IResourceResult | undefined;
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Defined in: [strategies/abstracts/IResourceStrategy.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/abstracts/IResourceStrategy.ts#L20)
|
|
81
|
+
|
|
82
|
+
Loads a resource by its key.
|
|
83
|
+
|
|
84
|
+
#### Parameters
|
|
85
|
+
|
|
86
|
+
| Parameter | Type | Description |
|
|
87
|
+
| ------ | ------ | ------ |
|
|
88
|
+
| `key` | `string` | The resource key/identifier |
|
|
89
|
+
|
|
90
|
+
#### Returns
|
|
91
|
+
|
|
92
|
+
[`IResourceResult`](Interface.IResourceResult) \| `undefined`
|
|
93
|
+
|
|
94
|
+
The resource result or undefined if not found
|
|
95
|
+
|
|
96
|
+
***
|
|
97
|
+
|
|
98
|
+
### loadAsync()
|
|
99
|
+
|
|
100
|
+
```ts
|
|
101
|
+
loadAsync(key): Promise<IResourceResult | undefined>;
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
Defined in: [strategies/abstracts/IResourceStrategy.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/abstracts/IResourceStrategy.ts#L28)
|
|
105
|
+
|
|
106
|
+
Loads a resource by its key (asynchronous).
|
|
107
|
+
|
|
108
|
+
#### Parameters
|
|
109
|
+
|
|
110
|
+
| Parameter | Type | Description |
|
|
111
|
+
| ------ | ------ | ------ |
|
|
112
|
+
| `key` | `string` | The resource key/identifier |
|
|
113
|
+
|
|
114
|
+
#### Returns
|
|
115
|
+
|
|
116
|
+
`Promise`\<[`IResourceResult`](Interface.IResourceResult) \| `undefined`\>
|
|
117
|
+
|
|
118
|
+
Promise resolving to the resource result or undefined if not found
|
|
119
|
+
|
|
120
|
+
***
|
|
121
|
+
|
|
122
|
+
### whatDoIHave()
|
|
123
|
+
|
|
124
|
+
```ts
|
|
125
|
+
whatDoIHave(): void;
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
Defined in: [strategies/abstracts/IResourceStrategy.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/abstracts/IResourceStrategy.ts#L49)
|
|
129
|
+
|
|
130
|
+
List all files and folders in the base paths for debugging purposes.
|
|
131
|
+
|
|
132
|
+
#### Returns
|
|
133
|
+
|
|
134
|
+
`void`
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '@breadstone/archipel-platform-resources'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# @breadstone/archipel-platform-resources
|
|
7
|
+
|
|
8
|
+
## Classes
|
|
9
|
+
|
|
10
|
+
| Class | Description |
|
|
11
|
+
| ------ | ------ |
|
|
12
|
+
| [BlobResourceStrategy](Class.BlobResourceStrategy) | Strategy for loading resources from blob storage. |
|
|
13
|
+
| [EmbeddedResourceStrategy](Class.EmbeddedResourceStrategy) | Strategy for loading embedded resources from memory. |
|
|
14
|
+
| [FileResourceStrategy](Class.FileResourceStrategy) | Strategy for loading resources from the local file system. |
|
|
15
|
+
| [ResourceManager](Class.ResourceManager) | Central manager for loading resources from various sources. Supports multiple strategies (file, blob, embedded) with caching. |
|
|
16
|
+
| [ResourceModule](Class.ResourceModule) | Module providing the ResourceManager. |
|
|
17
|
+
| [ResourceNotFoundError](Class.ResourceNotFoundError) | Error thrown when a Resource with a specified ID is not found. |
|
|
18
|
+
|
|
19
|
+
## Interfaces
|
|
20
|
+
|
|
21
|
+
| Interface | Description |
|
|
22
|
+
| ------ | ------ |
|
|
23
|
+
| [IBlobResourceStrategyConfig](Interface.IBlobResourceStrategyConfig) | Configuration for the blob resource strategy. |
|
|
24
|
+
| [IBlobServiceAdapter](Interface.IBlobServiceAdapter) | Minimal blob service interface to avoid circular dependencies. |
|
|
25
|
+
| [IFileResourceStrategyConfig](Interface.IFileResourceStrategyConfig) | Configuration for the file resource strategy. |
|
|
26
|
+
| [IResourceManagerConfig](Interface.IResourceManagerConfig) | Configuration for the ResourceManager. |
|
|
27
|
+
| [IResourceMetadata](Interface.IResourceMetadata) | Metadata about a resource. |
|
|
28
|
+
| [IResourceResult](Interface.IResourceResult) | Result of loading a resource. |
|
|
29
|
+
| [IResourceStrategy](Interface.IResourceStrategy) | Strategy for loading resources from a specific source. |
|
|
@@ -28,6 +28,24 @@ new OtelSdkHolder(): OtelSdkHolder;
|
|
|
28
28
|
|
|
29
29
|
`OtelSdkHolder`
|
|
30
30
|
|
|
31
|
+
## Accessors
|
|
32
|
+
|
|
33
|
+
### isInitialized
|
|
34
|
+
|
|
35
|
+
#### Get Signature
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
get isInitialized(): boolean;
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Defined in: [OtelSdkHolder.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/OtelSdkHolder.ts#L31)
|
|
42
|
+
|
|
43
|
+
Whether the OpenTelemetry SDK has been initialized.
|
|
44
|
+
|
|
45
|
+
##### Returns
|
|
46
|
+
|
|
47
|
+
`boolean`
|
|
48
|
+
|
|
31
49
|
## Methods
|
|
32
50
|
|
|
33
51
|
### onApplicationShutdown()
|
|
@@ -36,7 +54,7 @@ new OtelSdkHolder(): OtelSdkHolder;
|
|
|
36
54
|
onApplicationShutdown(): Promise<void>;
|
|
37
55
|
```
|
|
38
56
|
|
|
39
|
-
Defined in: [OtelSdkHolder.ts:
|
|
57
|
+
Defined in: [OtelSdkHolder.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/OtelSdkHolder.ts#L52)
|
|
40
58
|
|
|
41
59
|
#### Returns
|
|
42
60
|
|
|
@@ -58,7 +76,7 @@ OnApplicationShutdown.onApplicationShutdown
|
|
|
58
76
|
setSdk(sdk): void;
|
|
59
77
|
```
|
|
60
78
|
|
|
61
|
-
Defined in: [OtelSdkHolder.ts:
|
|
79
|
+
Defined in: [OtelSdkHolder.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/OtelSdkHolder.ts#L43)
|
|
62
80
|
|
|
63
81
|
Stores the SDK reference so it can be shut down later.
|
|
64
82
|
Can only be called once - subsequent calls are ignored.
|
|
@@ -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](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/health/TelemetryHealthIndicator.ts#L17)
|
|
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](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/health/TelemetryHealthIndicator.ts#L26)
|
|
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](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/health/TelemetryHealthIndicator.ts#L34)
|
|
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](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/health/TelemetryHealthIndicator.ts#L47)
|
|
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) |
|
|
@@ -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,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@breadstone/archipel-mcp",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.26",
|
|
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",
|