@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,60 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Class: ResourceNotFoundError'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Class: ResourceNotFoundError
|
|
7
|
+
|
|
8
|
+
Defined in: [errors/ResourceNotFoundError.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/errors/ResourceNotFoundError.ts#L6)
|
|
9
|
+
|
|
10
|
+
Error thrown when a Resource with a specified ID is not found.
|
|
11
|
+
|
|
12
|
+
## Extends
|
|
13
|
+
|
|
14
|
+
- `Error`
|
|
15
|
+
|
|
16
|
+
## Constructors
|
|
17
|
+
|
|
18
|
+
### Constructor
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
new ResourceNotFoundError(key): ResourceNotFoundError;
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Defined in: [errors/ResourceNotFoundError.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/errors/ResourceNotFoundError.ts#L7)
|
|
25
|
+
|
|
26
|
+
#### Parameters
|
|
27
|
+
|
|
28
|
+
| Parameter | Type |
|
|
29
|
+
| ------ | ------ |
|
|
30
|
+
| `key` | `string` |
|
|
31
|
+
|
|
32
|
+
#### Returns
|
|
33
|
+
|
|
34
|
+
`ResourceNotFoundError`
|
|
35
|
+
|
|
36
|
+
#### Overrides
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
Error.constructor
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Properties
|
|
43
|
+
|
|
44
|
+
### code
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
readonly code: "RESOURCE_NOT_FOUND" = 'RESOURCE_NOT_FOUND';
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Defined in: [errors/ResourceNotFoundError.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/errors/ResourceNotFoundError.ts#L11)
|
|
51
|
+
|
|
52
|
+
***
|
|
53
|
+
|
|
54
|
+
### key
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
readonly key: string;
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Defined in: [errors/ResourceNotFoundError.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/errors/ResourceNotFoundError.ts#L7)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IBlobResourceStrategyConfig'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IBlobResourceStrategyConfig
|
|
7
|
+
|
|
8
|
+
Defined in: [strategies/BlobResourceStrategy.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/BlobResourceStrategy.ts#L34)
|
|
9
|
+
|
|
10
|
+
Configuration for the blob resource strategy.
|
|
11
|
+
|
|
12
|
+
## Properties
|
|
13
|
+
|
|
14
|
+
### keyPrefix?
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
optional keyPrefix?: string;
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: [strategies/BlobResourceStrategy.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/BlobResourceStrategy.ts#L39)
|
|
21
|
+
|
|
22
|
+
Optional key prefix for blob storage.
|
|
23
|
+
|
|
24
|
+
#### Example
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
'resources/', 'templates/'
|
|
28
|
+
```
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IBlobServiceAdapter'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IBlobServiceAdapter
|
|
7
|
+
|
|
8
|
+
Defined in: [strategies/BlobResourceStrategy.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/BlobResourceStrategy.ts#L14)
|
|
9
|
+
|
|
10
|
+
Minimal blob service interface to avoid circular dependencies.
|
|
11
|
+
|
|
12
|
+
## Methods
|
|
13
|
+
|
|
14
|
+
### downloadFile()
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
downloadFile(key): Promise<{
|
|
18
|
+
contentType?: string;
|
|
19
|
+
data: unknown;
|
|
20
|
+
}>;
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Defined in: [strategies/BlobResourceStrategy.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/BlobResourceStrategy.ts#L21)
|
|
24
|
+
|
|
25
|
+
Downloads a file from blob storage.
|
|
26
|
+
|
|
27
|
+
#### Parameters
|
|
28
|
+
|
|
29
|
+
| Parameter | Type | Description |
|
|
30
|
+
| ------ | ------ | ------ |
|
|
31
|
+
| `key` | `string` | The blob key |
|
|
32
|
+
|
|
33
|
+
#### Returns
|
|
34
|
+
|
|
35
|
+
`Promise`\<\{
|
|
36
|
+
`contentType?`: `string`;
|
|
37
|
+
`data`: `unknown`;
|
|
38
|
+
\}\>
|
|
39
|
+
|
|
40
|
+
The download result
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IFileResourceStrategyConfig'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IFileResourceStrategyConfig
|
|
7
|
+
|
|
8
|
+
Defined in: [strategies/FileResourceStrategy.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/FileResourceStrategy.ts#L18)
|
|
9
|
+
|
|
10
|
+
Configuration for the file resource strategy.
|
|
11
|
+
|
|
12
|
+
## Properties
|
|
13
|
+
|
|
14
|
+
### basePaths
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
basePaths: string[];
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: [strategies/FileResourceStrategy.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/FileResourceStrategy.ts#L23)
|
|
21
|
+
|
|
22
|
+
Base paths to search for resources.
|
|
23
|
+
Paths are tried in order until the resource is found.
|
|
24
|
+
|
|
25
|
+
***
|
|
26
|
+
|
|
27
|
+
### defaultEncoding?
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
optional defaultEncoding?:
|
|
31
|
+
| "ascii"
|
|
32
|
+
| "utf8"
|
|
33
|
+
| "utf-8"
|
|
34
|
+
| "utf16le"
|
|
35
|
+
| "ucs2"
|
|
36
|
+
| "ucs-2"
|
|
37
|
+
| "base64"
|
|
38
|
+
| "base64url"
|
|
39
|
+
| "latin1"
|
|
40
|
+
| "binary"
|
|
41
|
+
| "hex";
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Defined in: [strategies/FileResourceStrategy.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/FileResourceStrategy.ts#L29)
|
|
45
|
+
|
|
46
|
+
Optional default encoding for text files.
|
|
47
|
+
|
|
48
|
+
#### Default
|
|
49
|
+
|
|
50
|
+
```ts
|
|
51
|
+
'utf-8'
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
***
|
|
55
|
+
|
|
56
|
+
### includeSubfolders?
|
|
57
|
+
|
|
58
|
+
```ts
|
|
59
|
+
optional includeSubfolders?: boolean;
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Defined in: [strategies/FileResourceStrategy.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/FileResourceStrategy.ts#L48)
|
|
63
|
+
|
|
64
|
+
Enable recursive search in subdirectories.
|
|
65
|
+
When enabled, the strategy will search for files in all subdirectories
|
|
66
|
+
of the base paths using glob patterns.
|
|
67
|
+
|
|
68
|
+
#### Default
|
|
69
|
+
|
|
70
|
+
```ts
|
|
71
|
+
false
|
|
72
|
+
```
|
|
@@ -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. |
|
|
@@ -132,4 +132,4 @@ export class CustomStrategy implements IResourceStrategy {
|
|
|
132
132
|
|
|
133
133
|
## API Reference
|
|
134
134
|
|
|
135
|
-
|
|
135
|
+
The auto-generated API reference is published when API docs are generated for this package.
|
|
@@ -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,10 +76,10 @@ 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
|
-
Can only be called once
|
|
82
|
+
Can only be called once - subsequent calls are ignored.
|
|
65
83
|
|
|
66
84
|
#### Parameters
|
|
67
85
|
|