@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
|
@@ -30,7 +30,7 @@ Use `RepositoryBase2` instead. This class will be removed in a future major vers
|
|
|
30
30
|
new RepositoryBase<TDelegate, TArgs, TReturn, TEntity>(db, model): RepositoryBase<TDelegate, TArgs, TReturn, TEntity>;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
33
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L62)
|
|
34
34
|
|
|
35
35
|
#### Parameters
|
|
36
36
|
|
|
@@ -53,7 +53,7 @@ Defined in: [repositories/abstracts/RepositoryBase.ts:61](https://github.com/Rue
|
|
|
53
53
|
get protected database(): DatabaseService;
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
56
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L85)
|
|
57
57
|
|
|
58
58
|
Provides access to the underlying DatabaseService for derived repositories.
|
|
59
59
|
Only to be used for transactional orchestration that spans multiple models.
|
|
@@ -72,7 +72,7 @@ Only to be used for transactional orchestration that spans multiple models.
|
|
|
72
72
|
get protected model(): TDelegate;
|
|
73
73
|
```
|
|
74
74
|
|
|
75
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
75
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L75)
|
|
76
76
|
|
|
77
77
|
##### Returns
|
|
78
78
|
|
|
@@ -86,7 +86,7 @@ Defined in: [repositories/abstracts/RepositoryBase.ts:74](https://github.com/Rue
|
|
|
86
86
|
protected aggregate<TResult>(args): Promise<TResult>;
|
|
87
87
|
```
|
|
88
88
|
|
|
89
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
89
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:255](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L255)
|
|
90
90
|
|
|
91
91
|
Performs aggregation operations on the records.
|
|
92
92
|
|
|
@@ -116,7 +116,7 @@ The aggregation result.
|
|
|
116
116
|
protected count<TResult>(args): Promise<TResult>;
|
|
117
117
|
```
|
|
118
118
|
|
|
119
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
119
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:267](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L267)
|
|
120
120
|
|
|
121
121
|
Counts the number of records that match the criteria.
|
|
122
122
|
|
|
@@ -146,7 +146,7 @@ The count of matching records.
|
|
|
146
146
|
protected create<TResult>(args): Promise<TResult>;
|
|
147
147
|
```
|
|
148
148
|
|
|
149
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
149
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:171](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L171)
|
|
150
150
|
|
|
151
151
|
Creates a new record.
|
|
152
152
|
|
|
@@ -176,7 +176,7 @@ The created record.
|
|
|
176
176
|
protected createMany<TResult>(args): Promise<TResult>;
|
|
177
177
|
```
|
|
178
178
|
|
|
179
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
179
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:183](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L183)
|
|
180
180
|
|
|
181
181
|
Creates multiple records.
|
|
182
182
|
|
|
@@ -206,7 +206,7 @@ The created records.
|
|
|
206
206
|
protected delete<TResult>(args): Promise<TResult>;
|
|
207
207
|
```
|
|
208
208
|
|
|
209
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
209
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:231](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L231)
|
|
210
210
|
|
|
211
211
|
Deletes a record by its identifier.
|
|
212
212
|
|
|
@@ -236,7 +236,7 @@ The deleted record.
|
|
|
236
236
|
protected deleteMany<TResult>(args): Promise<TResult>;
|
|
237
237
|
```
|
|
238
238
|
|
|
239
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
239
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:243](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L243)
|
|
240
240
|
|
|
241
241
|
Deletes multiple records by their identifiers.
|
|
242
242
|
|
|
@@ -266,7 +266,7 @@ The deleted records.
|
|
|
266
266
|
execute<TResult>(query): Promise<TResult>;
|
|
267
267
|
```
|
|
268
268
|
|
|
269
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
269
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:100](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L100)
|
|
270
270
|
|
|
271
271
|
Executes a predefined query against the underlying model.
|
|
272
272
|
|
|
@@ -296,7 +296,7 @@ The query result.
|
|
|
296
296
|
executeTransactional<TResult>(query): Promise<TResult>;
|
|
297
297
|
```
|
|
298
298
|
|
|
299
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
299
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L112)
|
|
300
300
|
|
|
301
301
|
Executes a transactional query providing a Prisma TransactionClient for multi-model work.
|
|
302
302
|
|
|
@@ -326,7 +326,7 @@ The query result.
|
|
|
326
326
|
protected findFirst<TResult>(args): Promise<TResult>;
|
|
327
327
|
```
|
|
328
328
|
|
|
329
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
329
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:159](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L159)
|
|
330
330
|
|
|
331
331
|
Finds the first record that matches the criteria.
|
|
332
332
|
|
|
@@ -356,7 +356,7 @@ The found record or null if not found.
|
|
|
356
356
|
findMany<TResult>(args?, page?): Promise<TResult>;
|
|
357
357
|
```
|
|
358
358
|
|
|
359
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
359
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:137](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L137)
|
|
360
360
|
|
|
361
361
|
Finds multiple records with optional pagination.
|
|
362
362
|
|
|
@@ -387,7 +387,7 @@ The found records.
|
|
|
387
387
|
protected findUnique<TResult>(args): Promise<TResult>;
|
|
388
388
|
```
|
|
389
389
|
|
|
390
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
390
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:124](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L124)
|
|
391
391
|
|
|
392
392
|
Finds a unique record by its identifier.
|
|
393
393
|
|
|
@@ -417,7 +417,7 @@ The found record or null if not found.
|
|
|
417
417
|
protected groupBy<TResult>(args): Promise<TResult>;
|
|
418
418
|
```
|
|
419
419
|
|
|
420
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
420
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:279](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L279)
|
|
421
421
|
|
|
422
422
|
Groups records by specified fields and performs aggregations.
|
|
423
423
|
|
|
@@ -447,7 +447,7 @@ The grouped records with aggregations.
|
|
|
447
447
|
protected merge<TResult>(entity): Promise<TResult>;
|
|
448
448
|
```
|
|
449
449
|
|
|
450
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
450
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:291](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L291)
|
|
451
451
|
|
|
452
452
|
Merges the given `data` with the user identified by the `id`.
|
|
453
453
|
|
|
@@ -477,7 +477,7 @@ The merged data.
|
|
|
477
477
|
protected tryCatch<T>(promise): Promise<T>;
|
|
478
478
|
```
|
|
479
479
|
|
|
480
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
480
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:325](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L325)
|
|
481
481
|
|
|
482
482
|
Wraps a promise in a try-catch block to handle errors uniformly.
|
|
483
483
|
|
|
@@ -507,7 +507,7 @@ The result of the promise or throws an error.
|
|
|
507
507
|
protected update<TResult>(args): Promise<TResult>;
|
|
508
508
|
```
|
|
509
509
|
|
|
510
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
510
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:195](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L195)
|
|
511
511
|
|
|
512
512
|
Updates an existing record.
|
|
513
513
|
|
|
@@ -537,7 +537,7 @@ The updated record.
|
|
|
537
537
|
protected updateMany<TResult>(args): Promise<TResult>;
|
|
538
538
|
```
|
|
539
539
|
|
|
540
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
540
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:207](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L207)
|
|
541
541
|
|
|
542
542
|
Updates multiple existing records.
|
|
543
543
|
|
|
@@ -567,7 +567,7 @@ The updated records.
|
|
|
567
567
|
protected upsert<TResult>(args): Promise<TResult>;
|
|
568
568
|
```
|
|
569
569
|
|
|
570
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
570
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:219](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L219)
|
|
571
571
|
|
|
572
572
|
Creates or updates a record based on its existence.
|
|
573
573
|
|
|
@@ -9,7 +9,7 @@ editUrl: false
|
|
|
9
9
|
function paginator(defaultOptions): PaginateFunction;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [features/Pagination.ts:
|
|
12
|
+
Defined in: [features/Pagination.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/features/Pagination.ts#L21)
|
|
13
13
|
|
|
14
14
|
## Parameters
|
|
15
15
|
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IDatabaseModuleConfig
|
|
7
7
|
|
|
8
|
-
Defined in: [DatabaseModule.ts:
|
|
8
|
+
Defined in: [DatabaseModule.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L15)
|
|
9
9
|
|
|
10
10
|
Represents the database module configuration.
|
|
11
11
|
|
|
@@ -17,7 +17,7 @@ Represents the database module configuration.
|
|
|
17
17
|
optional adapter?: unknown;
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
Defined in: [DatabaseModule.ts:
|
|
20
|
+
Defined in: [DatabaseModule.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L20)
|
|
21
21
|
|
|
22
22
|
A Prisma driver adapter instance (e.g. `PrismaPg`, `PrismaLibSQL`).
|
|
23
23
|
Required for Prisma 7+ with the new `prisma-client` generator.
|
|
@@ -30,6 +30,6 @@ Required for Prisma 7+ with the new `prisma-client` generator.
|
|
|
30
30
|
optional middlewares?: unknown[];
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [DatabaseModule.ts:
|
|
33
|
+
Defined in: [DatabaseModule.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L22)
|
|
34
34
|
|
|
35
35
|
Future extension point for Prisma middlewares
|
|
@@ -9,7 +9,7 @@ editUrl: false
|
|
|
9
9
|
type DelegateArgs<T> = { [K in keyof T]: T[K] extends (args: infer A) => Promise<unknown> ? A : never };
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
12
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:355](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L355)
|
|
13
13
|
|
|
14
14
|
## Type Parameters
|
|
15
15
|
|
|
@@ -9,7 +9,7 @@ editUrl: false
|
|
|
9
9
|
type DelegateReturnTypes<T> = { [K in keyof T]: T[K] extends (args: infer A) => Promise<infer R> ? R : never };
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
12
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:362](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L362)
|
|
13
13
|
|
|
14
14
|
## Type Parameters
|
|
15
15
|
|
|
@@ -9,7 +9,7 @@ editUrl: false
|
|
|
9
9
|
type PaginateFunction = <T, K>(model, args?, options?) => Promise<IPaginatedResult<T>>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [features/Pagination.ts:
|
|
12
|
+
Defined in: [features/Pagination.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/features/Pagination.ts#L18)
|
|
13
13
|
|
|
14
14
|
## Type Parameters
|
|
15
15
|
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const DATABASE_MODULE_CONFIG: "DATABASE_MODULE_CONFIG" = 'DATABASE_MODULE_CONFIG';
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [DatabaseModule.ts:
|
|
12
|
+
Defined in: [DatabaseModule.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L30)
|
|
13
13
|
|
|
14
14
|
Represents the database module.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: platform-database
|
|
3
3
|
description: Prisma ORM integration with PostgreSQL, repository pattern, query abstraction, and pagination.
|
|
4
4
|
order: 5
|
|
5
|
-
tags: [database, prisma, postgresql, repository, queries, pagination]
|
|
5
|
+
tags: [database, prisma, postgresql, repository, queries, pagination, health]
|
|
6
6
|
package: '@breadstone/archipel-platform-database'
|
|
7
7
|
---
|
|
8
8
|
|
|
@@ -294,13 +294,25 @@ interface IOrderEntity {
|
|
|
294
294
|
|
|
295
295
|
## Health Check
|
|
296
296
|
|
|
297
|
+
The `DatabaseHealthIndicator` verifies database connectivity via a Prisma ping (`SELECT 1`). Import it from the `/health` subpath:
|
|
298
|
+
|
|
297
299
|
```typescript
|
|
298
|
-
import { DatabaseHealthIndicator } from '@breadstone/archipel-platform-database';
|
|
300
|
+
import { DatabaseHealthIndicator } from '@breadstone/archipel-platform-database/health';
|
|
301
|
+
import { HealthModule } from '@breadstone/archipel-platform-health';
|
|
299
302
|
|
|
300
|
-
|
|
301
|
-
|
|
303
|
+
@Module({
|
|
304
|
+
imports: [
|
|
305
|
+
DatabaseModule,
|
|
306
|
+
HealthModule.withIndicators([DatabaseHealthIndicator]),
|
|
307
|
+
],
|
|
308
|
+
})
|
|
309
|
+
export class AppModule {}
|
|
302
310
|
```
|
|
303
311
|
|
|
312
|
+
| Key | Check | Dependencies |
|
|
313
|
+
| --- | ----- | ------------ |
|
|
314
|
+
| `database` | Prisma `SELECT 1` ping | `PrismaHealthIndicator`, `DatabaseService` |
|
|
315
|
+
|
|
304
316
|
---
|
|
305
317
|
|
|
306
318
|
## Exports Summary
|
|
@@ -314,7 +326,7 @@ import { DatabaseHealthIndicator } from '@breadstone/archipel-platform-database'
|
|
|
314
326
|
| `query()` | Factory | Create typed query objects |
|
|
315
327
|
| `transactionalQuery()` | Factory | Create transactional query objects |
|
|
316
328
|
| `paginator()` | Factory | Create pagination helper |
|
|
317
|
-
| `DatabaseHealthIndicator` | Health | PostgreSQL health check
|
|
329
|
+
| `DatabaseHealthIndicator` | Health | PostgreSQL health check (`/health` subpath) |
|
|
318
330
|
| `PLATFORM_DATABASE_CONFIG_ENTRIES` | Constant | Config entries for `ConfigModule` |
|
|
319
331
|
| `DB_ACCELERATE_URL` | Config Key | Prisma Accelerate URL |
|
|
320
332
|
| `DB_AUTO_CONNECTION` | Config Key | Auto-connect toggle |
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: DocumentEngine
|
|
7
7
|
|
|
8
|
-
Defined in: [engine/DocumentEngine.ts:
|
|
8
|
+
Defined in: [engine/DocumentEngine.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L20)
|
|
9
9
|
|
|
10
10
|
DocumentEngine orchestrates document generation workflow.
|
|
11
11
|
Coordinates resource loading and renderer components.
|
|
@@ -15,10 +15,13 @@ Coordinates resource loading and renderer components.
|
|
|
15
15
|
### Constructor
|
|
16
16
|
|
|
17
17
|
```ts
|
|
18
|
-
new DocumentEngine(
|
|
18
|
+
new DocumentEngine(
|
|
19
|
+
resourceManager,
|
|
20
|
+
renderers,
|
|
21
|
+
options): DocumentEngine;
|
|
19
22
|
```
|
|
20
23
|
|
|
21
|
-
Defined in: [engine/DocumentEngine.ts:
|
|
24
|
+
Defined in: [engine/DocumentEngine.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L46)
|
|
22
25
|
|
|
23
26
|
#### Parameters
|
|
24
27
|
|
|
@@ -26,6 +29,7 @@ Defined in: [engine/DocumentEngine.ts:44](https://github.com/RueDeRennes/archipe
|
|
|
26
29
|
| ------ | ------ |
|
|
27
30
|
| `resourceManager` | `ResourceManager` |
|
|
28
31
|
| `renderers` | [`IDocumentRenderer`](Interface.IDocumentRenderer)[] |
|
|
32
|
+
| `options` | [`IDocumentModuleOptions`](Interface.IDocumentModuleOptions) |
|
|
29
33
|
|
|
30
34
|
#### Returns
|
|
31
35
|
|
|
@@ -41,7 +45,7 @@ Defined in: [engine/DocumentEngine.ts:44](https://github.com/RueDeRennes/archipe
|
|
|
41
45
|
get renderers(): ReadonlyMap<string, IDocumentRenderer>;
|
|
42
46
|
```
|
|
43
47
|
|
|
44
|
-
Defined in: [engine/DocumentEngine.ts:
|
|
48
|
+
Defined in: [engine/DocumentEngine.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L38)
|
|
45
49
|
|
|
46
50
|
Get available renderers.
|
|
47
51
|
|
|
@@ -61,7 +65,7 @@ render(options): Promise<IRenderResult & {
|
|
|
61
65
|
}>;
|
|
62
66
|
```
|
|
63
67
|
|
|
64
|
-
Defined in: [engine/DocumentEngine.ts:
|
|
68
|
+
Defined in: [engine/DocumentEngine.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L77)
|
|
65
69
|
|
|
66
70
|
Render a document from template.
|
|
67
71
|
|
|
@@ -49,7 +49,7 @@ export class AppModule {}
|
|
|
49
49
|
|
|
50
50
|
## DocumentEngine
|
|
51
51
|
|
|
52
|
-
Main orchestrator for document rendering.
|
|
52
|
+
Main orchestrator for document rendering. Emits debug-level logs for document format detection and renderer initialization to aid troubleshooting.
|
|
53
53
|
|
|
54
54
|
### Render from Template
|
|
55
55
|
|
|
@@ -210,6 +210,30 @@ The signing request with current status.
|
|
|
210
210
|
|
|
211
211
|
***
|
|
212
212
|
|
|
213
|
+
### ping()
|
|
214
|
+
|
|
215
|
+
```ts
|
|
216
|
+
ping(): Promise<boolean>;
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
Defined in: [contracts/EsigningClientPort.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningClientPort.ts#L97)
|
|
220
|
+
|
|
221
|
+
Lightweight connectivity check for the e-signing provider.
|
|
222
|
+
Override in adapters to perform a real API call (e.g. account info).
|
|
223
|
+
Defaults to `true` if not overridden.
|
|
224
|
+
|
|
225
|
+
#### Returns
|
|
226
|
+
|
|
227
|
+
`Promise`\<`boolean`\>
|
|
228
|
+
|
|
229
|
+
`true` if the provider is reachable.
|
|
230
|
+
|
|
231
|
+
#### Inherited from
|
|
232
|
+
|
|
233
|
+
[`EsigningClientPort`](Class.EsigningClientPort).[`ping`](Class.EsigningClientPort#ping)
|
|
234
|
+
|
|
235
|
+
***
|
|
236
|
+
|
|
213
237
|
### verifyWebhook()
|
|
214
238
|
|
|
215
239
|
```ts
|
|
@@ -204,6 +204,30 @@ The signing request with current status.
|
|
|
204
204
|
|
|
205
205
|
***
|
|
206
206
|
|
|
207
|
+
### ping()
|
|
208
|
+
|
|
209
|
+
```ts
|
|
210
|
+
ping(): Promise<boolean>;
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
Defined in: [contracts/EsigningClientPort.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningClientPort.ts#L97)
|
|
214
|
+
|
|
215
|
+
Lightweight connectivity check for the e-signing provider.
|
|
216
|
+
Override in adapters to perform a real API call (e.g. account info).
|
|
217
|
+
Defaults to `true` if not overridden.
|
|
218
|
+
|
|
219
|
+
#### Returns
|
|
220
|
+
|
|
221
|
+
`Promise`\<`boolean`\>
|
|
222
|
+
|
|
223
|
+
`true` if the provider is reachable.
|
|
224
|
+
|
|
225
|
+
#### Inherited from
|
|
226
|
+
|
|
227
|
+
[`EsigningClientPort`](Class.EsigningClientPort).[`ping`](Class.EsigningClientPort#ping)
|
|
228
|
+
|
|
229
|
+
***
|
|
230
|
+
|
|
207
231
|
### verifyWebhook()
|
|
208
232
|
|
|
209
233
|
```ts
|
|
@@ -204,6 +204,30 @@ The signing request with current status.
|
|
|
204
204
|
|
|
205
205
|
***
|
|
206
206
|
|
|
207
|
+
### ping()
|
|
208
|
+
|
|
209
|
+
```ts
|
|
210
|
+
ping(): Promise<boolean>;
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
Defined in: [contracts/EsigningClientPort.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningClientPort.ts#L97)
|
|
214
|
+
|
|
215
|
+
Lightweight connectivity check for the e-signing provider.
|
|
216
|
+
Override in adapters to perform a real API call (e.g. account info).
|
|
217
|
+
Defaults to `true` if not overridden.
|
|
218
|
+
|
|
219
|
+
#### Returns
|
|
220
|
+
|
|
221
|
+
`Promise`\<`boolean`\>
|
|
222
|
+
|
|
223
|
+
`true` if the provider is reachable.
|
|
224
|
+
|
|
225
|
+
#### Inherited from
|
|
226
|
+
|
|
227
|
+
[`EsigningClientPort`](Class.EsigningClientPort).[`ping`](Class.EsigningClientPort#ping)
|
|
228
|
+
|
|
229
|
+
***
|
|
230
|
+
|
|
207
231
|
### verifyWebhook()
|
|
208
232
|
|
|
209
233
|
```ts
|
|
@@ -163,6 +163,26 @@ The signing request with current status.
|
|
|
163
163
|
|
|
164
164
|
***
|
|
165
165
|
|
|
166
|
+
### ping()
|
|
167
|
+
|
|
168
|
+
```ts
|
|
169
|
+
ping(): Promise<boolean>;
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
Defined in: [contracts/EsigningClientPort.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningClientPort.ts#L97)
|
|
173
|
+
|
|
174
|
+
Lightweight connectivity check for the e-signing provider.
|
|
175
|
+
Override in adapters to perform a real API call (e.g. account info).
|
|
176
|
+
Defaults to `true` if not overridden.
|
|
177
|
+
|
|
178
|
+
#### Returns
|
|
179
|
+
|
|
180
|
+
`Promise`\<`boolean`\>
|
|
181
|
+
|
|
182
|
+
`true` if the provider is reachable.
|
|
183
|
+
|
|
184
|
+
***
|
|
185
|
+
|
|
166
186
|
### verifyWebhook()
|
|
167
187
|
|
|
168
188
|
```ts
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Class: EsigningHealthIndicator'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Class: EsigningHealthIndicator
|
|
7
|
+
|
|
8
|
+
Defined in: health/EsigningHealthIndicator.ts:17
|
|
9
|
+
|
|
10
|
+
Health indicator for the e-signing infrastructure.
|
|
11
|
+
Calls [EsigningClientPort.ping](Class.EsigningClientPort#ping) to verify provider connectivity.
|
|
12
|
+
|
|
13
|
+
## Implements
|
|
14
|
+
|
|
15
|
+
- `IHealthIndicator`
|
|
16
|
+
|
|
17
|
+
## Constructors
|
|
18
|
+
|
|
19
|
+
### Constructor
|
|
20
|
+
|
|
21
|
+
```ts
|
|
22
|
+
new EsigningHealthIndicator(esigningClient?): EsigningHealthIndicator;
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Defined in: health/EsigningHealthIndicator.ts:27
|
|
26
|
+
|
|
27
|
+
#### Parameters
|
|
28
|
+
|
|
29
|
+
| Parameter | Type |
|
|
30
|
+
| ------ | ------ |
|
|
31
|
+
| `esigningClient?` | [`EsigningClientPort`](Class.EsigningClientPort) |
|
|
32
|
+
|
|
33
|
+
#### Returns
|
|
34
|
+
|
|
35
|
+
`EsigningHealthIndicator`
|
|
36
|
+
|
|
37
|
+
## Properties
|
|
38
|
+
|
|
39
|
+
### key
|
|
40
|
+
|
|
41
|
+
```ts
|
|
42
|
+
readonly key: string = 'esigning';
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Defined in: health/EsigningHealthIndicator.ts:35
|
|
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(): Promise<HealthIndicatorResult<string>>;
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Defined in: health/EsigningHealthIndicator.ts:48
|
|
64
|
+
|
|
65
|
+
Pings the e-signing provider to verify connectivity.
|
|
66
|
+
Returns disabled status when no client is configured.
|
|
67
|
+
|
|
68
|
+
#### Returns
|
|
69
|
+
|
|
70
|
+
`Promise`\<`HealthIndicatorResult`\<`string`\>\>
|
|
71
|
+
|
|
72
|
+
The health indicator result.
|
|
73
|
+
|
|
74
|
+
#### Implementation of
|
|
75
|
+
|
|
76
|
+
```ts
|
|
77
|
+
IHealthIndicator.check
|
|
78
|
+
```
|
|
@@ -221,6 +221,30 @@ The signing request with current status.
|
|
|
221
221
|
|
|
222
222
|
***
|
|
223
223
|
|
|
224
|
+
### ping()
|
|
225
|
+
|
|
226
|
+
```ts
|
|
227
|
+
ping(): Promise<boolean>;
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
Defined in: [contracts/EsigningClientPort.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningClientPort.ts#L97)
|
|
231
|
+
|
|
232
|
+
Lightweight connectivity check for the e-signing provider.
|
|
233
|
+
Override in adapters to perform a real API call (e.g. account info).
|
|
234
|
+
Defaults to `true` if not overridden.
|
|
235
|
+
|
|
236
|
+
#### Returns
|
|
237
|
+
|
|
238
|
+
`Promise`\<`boolean`\>
|
|
239
|
+
|
|
240
|
+
`true` if the provider is reachable.
|
|
241
|
+
|
|
242
|
+
#### Inherited from
|
|
243
|
+
|
|
244
|
+
[`EsigningClientPort`](Class.EsigningClientPort).[`ping`](Class.EsigningClientPort#ping)
|
|
245
|
+
|
|
246
|
+
***
|
|
247
|
+
|
|
224
248
|
### verifyWebhook()
|
|
225
249
|
|
|
226
250
|
```ts
|
|
@@ -14,6 +14,7 @@ editUrl: false
|
|
|
14
14
|
| [DropboxSignEsigningProvider](Class.DropboxSignEsigningProvider) | Dropbox Sign (HelloSign) e-signing provider. Integrates with the Dropbox Sign API v3 via the official `@dropbox/sign` Node.js SDK. |
|
|
15
15
|
| [EsigningClientPort](Class.EsigningClientPort) | Abstract port for e-signing provider clients. Each provider (DocuSign, Adobe Sign, Dropbox Sign, Internal) must implement this contract so that the consuming application can switch providers without changing business logic. |
|
|
16
16
|
| [EsigningError](Class.EsigningError) | Base error for all e-signing related failures. |
|
|
17
|
+
| [EsigningHealthIndicator](Class.EsigningHealthIndicator) | Health indicator for the e-signing infrastructure. Calls [EsigningClientPort.ping](Class.EsigningClientPort#ping) to verify provider connectivity. |
|
|
17
18
|
| [EsigningModule](Class.EsigningModule) | NestJS module providing generic e-signing infrastructure. Exposes a configurable signing client and optional persistence tracking. The specific e-signing provider is selected via the options. |
|
|
18
19
|
| [EsigningPersistencePort](Class.EsigningPersistencePort) | Abstract port for persisting signing request state. Implement this port in the consuming application to track signing requests in a database. |
|
|
19
20
|
| [EsigningService](Class.EsigningService) | Application-level service for e-signing operations. Delegates to the configured [EsigningClientPort](Class.EsigningClientPort) and optionally invokes the [EsigningPersistencePort](Class.EsigningPersistencePort) for state tracking. |
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: platform-esigning
|
|
3
3
|
description: Provider-agnostic e-signing infrastructure with support for DocuSign, Adobe Sign, Dropbox Sign, and a built-in internal provider.
|
|
4
4
|
order: 5
|
|
5
|
-
tags: [esigning, docusign, adobe-sign, dropbox-sign, digital-signatures, ports-and-adapters, webhooks]
|
|
5
|
+
tags: [esigning, docusign, adobe-sign, dropbox-sign, digital-signatures, ports-and-adapters, webhooks, health]
|
|
6
6
|
package: '@breadstone/archipel-platform-esigning'
|
|
7
7
|
---
|
|
8
8
|
|
|
@@ -147,7 +147,7 @@ import { DOCUSIGN_CONFIG_ENTRIES } from '@breadstone/archipel-platform-esigning/
|
|
|
147
147
|
| `ADOBE_SIGN_INTEGRATION_KEY` | Adobe Sign integration key | Yes |
|
|
148
148
|
| `ADOBE_SIGN_CLIENT_SECRET` | Adobe Sign client secret | Yes |
|
|
149
149
|
| `ADOBE_SIGN_BASE_URL` | Adobe Sign base URL | Yes |
|
|
150
|
-
| `ADOBE_SIGN_WEBHOOK_CLIENT_ID` | Adobe Sign webhook client ID for verification |
|
|
150
|
+
| `ADOBE_SIGN_WEBHOOK_CLIENT_ID` | Adobe Sign webhook client ID for verification | Yes |
|
|
151
151
|
|
|
152
152
|
```typescript
|
|
153
153
|
import { ADOBE_SIGN_CONFIG_ENTRIES } from '@breadstone/archipel-platform-esigning/adobe-sign';
|
|
@@ -649,6 +649,29 @@ EsigningModule.register({
|
|
|
649
649
|
|
|
650
650
|
---
|
|
651
651
|
|
|
652
|
+
## Health Check
|
|
653
|
+
|
|
654
|
+
The `EsigningHealthIndicator` verifies that an `EsigningClientPort` is injected. If no e-signing client is registered, it reports `disabled: true`. Import it from the `/health` subpath:
|
|
655
|
+
|
|
656
|
+
```typescript
|
|
657
|
+
import { EsigningHealthIndicator } from '@breadstone/archipel-platform-esigning/health';
|
|
658
|
+
import { HealthModule } from '@breadstone/archipel-platform-health';
|
|
659
|
+
|
|
660
|
+
@Module({
|
|
661
|
+
imports: [
|
|
662
|
+
EsigningModule.register({ /* ... */ }),
|
|
663
|
+
HealthModule.withIndicators([EsigningHealthIndicator]),
|
|
664
|
+
],
|
|
665
|
+
})
|
|
666
|
+
export class AppModule {}
|
|
667
|
+
```
|
|
668
|
+
|
|
669
|
+
| Key | Check | Dependencies |
|
|
670
|
+
| --- | ----- | ------------ |
|
|
671
|
+
| `esigning` | `up` if `EsigningClientPort` injected, else `disabled` | `@Optional() EsigningClientPort` |
|
|
672
|
+
|
|
673
|
+
---
|
|
674
|
+
|
|
652
675
|
## Exports Summary
|
|
653
676
|
|
|
654
677
|
| Export | Type | Description |
|
|
@@ -682,3 +705,4 @@ EsigningModule.register({
|
|
|
682
705
|
| `ESIGNING_API_KEY` | Config Key | Generic API key config |
|
|
683
706
|
| `ESIGNING_WEBHOOK_SECRET` | Config Key | Generic webhook secret config |
|
|
684
707
|
| `ESIGNING_API_BASE_URL` | Config Key | Generic base URL config |
|
|
708
|
+
| `EsigningHealthIndicator` | Health | E-signing readiness check (`/health` subpath) |
|