@breadstone/archipel-mcp 0.0.20 → 0.0.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data/guides/ai-text-generation.md +10 -0
- package/data/guides/analytics-and-error-tracking.md +6 -0
- package/data/guides/cryptography-and-otp.md +20 -2
- package/data/guides/database-setup.md +4 -3
- package/data/guides/document-generation.md +26 -0
- package/data/guides/email-delivery.md +23 -0
- package/data/guides/email-templates.md +298 -0
- package/data/guides/esigning-integration.md +1 -1
- package/data/guides/getting-started.md +6 -6
- package/data/guides/index.md +1 -0
- package/data/guides/mcp-server.md +9 -0
- package/data/guides/payments-and-feature-gating.md +18 -0
- package/data/guides/resource-management.md +9 -9
- package/data/guides/telemetry-and-observability.md +7 -1
- package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +55 -6
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +32 -6
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +55 -6
- package/data/packages/platform-analytics/index.md +13 -0
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +1 -1
- package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +1 -1
- package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +1 -1
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +1 -1
- package/data/packages/platform-core/api/Class.ErrorTemplateService.md +1 -1
- package/data/packages/platform-core/api/Class.EventHub.md +7 -7
- package/data/packages/platform-core/api/Class.HostService.md +1 -1
- package/data/packages/platform-core/api/Class.SseHub.md +29 -6
- package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +1 -1
- package/data/packages/platform-core/api/index.md +0 -27
- package/data/packages/platform-core/index.md +8 -4
- package/data/packages/platform-cryptography/api/Class.BcryptService.md +4 -4
- package/data/packages/platform-cryptography/api/Class.CryptoService.md +3 -3
- package/data/packages/platform-cryptography/api/Class.OtpService.md +6 -6
- package/data/packages/platform-cryptography/api/Variable.BCRYPT_OPTIONS.md +2 -2
- package/data/packages/platform-cryptography/api/Variable.MAX_BCRYPT_PASSWORD_BYTES.md +1 -1
- package/data/packages/platform-cryptography/api/Variable.MIN_BCRYPT_ROUNDS.md +1 -1
- package/data/packages/platform-cryptography/api/Variable.OTP_OPTIONS.md +2 -2
- package/data/packages/platform-cryptography/api/Variable.OTP_SERVICE_TOKEN.md +2 -2
- package/data/packages/platform-cryptography/api/Variable.TOTP_EPOCH_TOLERANCE.md +1 -1
- package/data/packages/platform-cryptography/api/index.md +3 -3
- package/data/packages/platform-cryptography/index.md +10 -0
- package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +32 -1
- package/data/packages/platform-documents/api/Class.DocumentEngine.md +4 -4
- package/data/packages/platform-documents/api/Class.DocumentError.md +61 -0
- package/data/packages/platform-documents/api/Class.DocumentModule.md +2 -2
- package/data/packages/platform-documents/api/Class.DocumentRenderError.md +53 -0
- package/data/packages/platform-documents/api/Class.DocumentValidationError.md +52 -0
- package/data/packages/platform-documents/api/Class.DocxDocumentRenderer2.md +333 -0
- package/data/packages/platform-documents/api/Class.ImageProcessingError.md +53 -0
- package/data/packages/platform-documents/api/Class.PdfDocumentRenderer.md +355 -0
- package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +5 -5
- package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +31 -5
- package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +1 -1
- package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +1 -1
- package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +1 -1
- package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +1 -1
- package/data/packages/platform-documents/api/index.md +6 -0
- package/data/packages/platform-documents/index.md +27 -0
- package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +2 -2
- package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +8 -8
- package/data/packages/platform-esigning/index.md +2 -0
- package/data/packages/platform-health/index.md +128 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +3 -3
- package/data/packages/platform-intelligence/api/Class.IntelligenceConfigurationError.md +50 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +27 -4
- package/data/packages/platform-intelligence/api/Class.IntelligenceValidationError.md +50 -0
- package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +1 -1
- package/data/packages/platform-intelligence/api/index.md +2 -0
- package/data/packages/platform-intelligence/index.md +32 -0
- package/data/packages/platform-logging/api/Class.LoggerModule.md +1 -1
- package/data/packages/platform-logging/index.md +2 -0
- package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +0 -1
- package/data/packages/platform-mailing/api/Class.MailDeliveryError.md +65 -0
- package/data/packages/platform-mailing/api/Class.MailModule.md +1 -1
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +0 -5
- package/data/packages/platform-mailing/api/Variable.SMTP_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-mailing/api/Variable.SMTP_HOST.md +14 -0
- package/data/packages/platform-mailing/api/Variable.SMTP_PASSWORD.md +14 -0
- package/data/packages/platform-mailing/api/Variable.SMTP_PORT.md +14 -0
- package/data/packages/platform-mailing/api/Variable.SMTP_SECURE.md +14 -0
- package/data/packages/platform-mailing/api/Variable.SMTP_USER.md +14 -0
- package/data/packages/platform-mailing/api/index.md +7 -3
- package/data/packages/platform-mailing/index.md +29 -0
- package/data/packages/platform-mapping/index.md +121 -0
- package/data/packages/platform-mcp/api/Class.McpServerService.md +8 -8
- package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +1 -1
- package/data/packages/platform-mcp/index.md +11 -0
- package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +4 -4
- package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +2 -2
- package/data/packages/platform-openapi/index.md +1 -1
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +6 -6
- package/data/packages/platform-payments/api/Class.MollieClient.md +6 -6
- package/data/packages/platform-payments/api/Class.PaddleClient.md +6 -6
- package/data/packages/platform-payments/api/Class.PaymentError.md +65 -0
- package/data/packages/platform-payments/api/Class.StripeClient.md +6 -6
- package/data/packages/platform-payments/api/index.md +1 -0
- package/data/packages/platform-payments/index.md +29 -0
- package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +1 -1
- package/data/packages/platform-reporting/index.md +3 -1
- package/data/packages/platform-resources/index.md +135 -0
- package/data/packages/platform-telemetry/api/Class.MetricsService.md +29 -3
- package/data/packages/platform-telemetry/api/Class.OtelSdkHolder.md +3 -2
- package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +6 -6
- package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +3 -3
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +1 -1
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +1 -1
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +1 -1
- package/data/packages/platform-telemetry/api/index.md +1 -1
- package/data/packages/platform-telemetry/index.md +3 -1
- package/{src/knowledge/configPattern.js → data/patterns/config-pattern.md} +44 -47
- package/{src/knowledge/dtoPattern.js → data/patterns/dto-pattern.md} +58 -61
- package/{src/knowledge/errorHandlingPattern.js → data/patterns/error-handling-pattern.md} +35 -38
- package/{src/knowledge/guardPattern.js → data/patterns/guard-pattern.md} +35 -38
- package/{src/knowledge/mappingPattern.js → data/patterns/mapping-pattern.md} +43 -144
- package/data/patterns/module-pattern.md +182 -0
- package/data/patterns/query-pattern.md +137 -0
- package/data/patterns/repository-pattern.md +208 -0
- package/{src/knowledge/testingPattern.js → data/patterns/testing-pattern.md} +37 -40
- package/package.json +1 -1
- package/src/PatternsLoader.d.ts +12 -0
- package/src/PatternsLoader.js +65 -0
- package/src/generators/mappingPatternGenerator.d.ts +5 -0
- package/src/generators/mappingPatternGenerator.js +107 -0
- package/src/generators/modulePatternGenerator.d.ts +5 -0
- package/src/generators/modulePatternGenerator.js +107 -0
- package/src/generators/queryPatternGenerator.d.ts +4 -0
- package/src/generators/queryPatternGenerator.js +83 -0
- package/src/generators/repositoryPatternGenerator.d.ts +5 -0
- package/src/generators/repositoryPatternGenerator.js +165 -0
- package/src/main.js +15 -9
- package/src/models/IPatternDoc.d.ts +15 -0
- package/src/models/IPatternDoc.js +3 -0
- package/src/tools/registerGetConfigPatternTool.d.ts +2 -1
- package/src/tools/registerGetConfigPatternTool.js +4 -3
- package/src/tools/registerGetDtoPatternTool.d.ts +2 -1
- package/src/tools/registerGetDtoPatternTool.js +4 -3
- package/src/tools/registerGetErrorHandlingPatternTool.d.ts +2 -1
- package/src/tools/registerGetErrorHandlingPatternTool.js +4 -3
- package/src/tools/registerGetGuardPatternTool.d.ts +2 -1
- package/src/tools/registerGetGuardPatternTool.js +4 -3
- package/src/tools/registerGetMappingPatternTool.d.ts +2 -1
- package/src/tools/registerGetMappingPatternTool.js +5 -4
- package/src/tools/registerGetModulePatternTool.d.ts +2 -1
- package/src/tools/registerGetModulePatternTool.js +5 -4
- package/src/tools/registerGetQueryPatternTool.d.ts +2 -1
- package/src/tools/registerGetQueryPatternTool.js +5 -4
- package/src/tools/registerGetRepositoryPatternTool.d.ts +2 -1
- package/src/tools/registerGetRepositoryPatternTool.js +5 -4
- package/src/tools/registerGetTestingPatternTool.d.ts +2 -1
- package/src/tools/registerGetTestingPatternTool.js +4 -3
- package/data/packages/platform-core/api/Class.BlobResourceStrategy.md +0 -195
- package/data/packages/platform-core/api/Class.EmbeddedResourceStrategy.md +0 -215
- package/data/packages/platform-core/api/Class.FileResourceStrategy.md +0 -192
- package/data/packages/platform-core/api/Class.HealthModule.md +0 -42
- package/data/packages/platform-core/api/Class.HealthOrchestrator.md +0 -64
- package/data/packages/platform-core/api/Class.MappingBuilder.md +0 -110
- package/data/packages/platform-core/api/Class.MappingModule.md +0 -46
- package/data/packages/platform-core/api/Class.MappingNotRegisteredError.md +0 -56
- package/data/packages/platform-core/api/Class.MappingProfileBase.md +0 -52
- package/data/packages/platform-core/api/Class.MappingService.md +0 -284
- package/data/packages/platform-core/api/Class.ResourceManager.md +0 -565
- package/data/packages/platform-core/api/Class.ResourceModule.md +0 -46
- package/data/packages/platform-core/api/Class.TypeMappingNotRegisteredError.md +0 -57
- package/data/packages/platform-core/api/Function.createMappingKey.md +0 -39
- package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md +0 -28
- package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md +0 -40
- package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md +0 -72
- package/data/packages/platform-core/api/Interface.IHealthCheckResult.md +0 -46
- package/data/packages/platform-core/api/Interface.IHealthIndicator.md +0 -41
- package/data/packages/platform-core/api/Interface.IMappingBuilder.md +0 -76
- package/data/packages/platform-core/api/Interface.IMappingKey.md +0 -58
- package/data/packages/platform-core/api/Interface.IMappingProfile.md +0 -32
- package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +0 -89
- package/data/packages/platform-core/api/Interface.IResourceMetadata.md +0 -94
- package/data/packages/platform-core/api/Interface.IResourceResult.md +0 -34
- package/data/packages/platform-core/api/Interface.IResourceStrategy.md +0 -134
- package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +0 -14
- package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +0 -60
- package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +0 -58
- package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +0 -71
- package/src/knowledge/configPattern.d.ts +0 -5
- package/src/knowledge/dtoPattern.d.ts +0 -5
- package/src/knowledge/errorHandlingPattern.d.ts +0 -5
- package/src/knowledge/guardPattern.d.ts +0 -5
- package/src/knowledge/mappingPattern.d.ts +0 -6
- package/src/knowledge/modulePattern.d.ts +0 -6
- package/src/knowledge/modulePattern.js +0 -283
- package/src/knowledge/queryPattern.d.ts +0 -6
- package/src/knowledge/queryPattern.js +0 -215
- package/src/knowledge/repositoryPattern.d.ts +0 -6
- package/src/knowledge/repositoryPattern.js +0 -367
- package/src/knowledge/testingPattern.d.ts +0 -5
|
@@ -16,7 +16,6 @@ editUrl: false
|
|
|
16
16
|
| Class | Description |
|
|
17
17
|
| ------ | ------ |
|
|
18
18
|
| [AppHealthIndicator](Class.AppHealthIndicator) | Health indicator for the application. |
|
|
19
|
-
| [BlobResourceStrategy](Class.BlobResourceStrategy) | Strategy for loading resources from blob storage. |
|
|
20
19
|
| [BooleanUtils](Class.BooleanUtils) | Boolean Utility Class. This class provides static methods to parse and format boolean values. |
|
|
21
20
|
| [CasingInterceptor](Class.CasingInterceptor) | Global NestJS interceptor that normalizes property casing across the HTTP boundary. |
|
|
22
21
|
| [CatchUtils](Class.CatchUtils) | - |
|
|
@@ -24,15 +23,11 @@ editUrl: false
|
|
|
24
23
|
| [CUIDGenerator](Class.CUIDGenerator) | CUID Generator class |
|
|
25
24
|
| [DateTimeUtils](Class.DateTimeUtils) | TimeSpan Utility Class. Provides methods to parse and format time span values. |
|
|
26
25
|
| [DeviceParserService](Class.DeviceParserService) | The `DeviceParserService` class. |
|
|
27
|
-
| [EmbeddedResourceStrategy](Class.EmbeddedResourceStrategy) | Strategy for loading embedded resources from memory. |
|
|
28
26
|
| [ErrorTemplateService](Class.ErrorTemplateService) | Service for rendering error page templates. |
|
|
29
27
|
| [EventHub](Class.EventHub) | Provides a strongly typed event hub that can publish and subscribe to events. |
|
|
30
28
|
| [EventModule](Class.EventModule) | Module that provides event hub services. |
|
|
31
|
-
| [FileResourceStrategy](Class.FileResourceStrategy) | Strategy for loading resources from the local file system. |
|
|
32
29
|
| [GlobalExceptionFilter](Class.GlobalExceptionFilter) | A global exception filter that handles all uncaught exceptions in the application. Returns HTML error pages for browser requests and JSON for API requests. |
|
|
33
30
|
| [GUIDGenerator](Class.GUIDGenerator) | GUID Generator class |
|
|
34
|
-
| [HealthModule](Class.HealthModule) | - |
|
|
35
|
-
| [HealthOrchestrator](Class.HealthOrchestrator) | Orchestrates execution of all registered health indicators and aggregates their results. |
|
|
36
31
|
| [HostModule](Class.HostModule) | The `HostModule` provides host-related services globally. |
|
|
37
32
|
| [HostService](Class.HostService) | The `HostService` class. |
|
|
38
33
|
| [HttpLoggerMiddleware](Class.HttpLoggerMiddleware) | - |
|
|
@@ -41,24 +36,16 @@ editUrl: false
|
|
|
41
36
|
| [LimitRequestSizeMiddleware](Class.LimitRequestSizeMiddleware) | - |
|
|
42
37
|
| [LocalizedTextRequest](Class.LocalizedTextRequest) | Request DTO for a single localized text entry. |
|
|
43
38
|
| [LocalizedTextResponse](Class.LocalizedTextResponse) | Base class for localized text responses. |
|
|
44
|
-
| [MappingBuilder](Class.MappingBuilder) | A mapping builder that uses the mapping service to register maps. |
|
|
45
|
-
| [MappingModule](Class.MappingModule) | Module that provides mapping services and allows registration of mapping profiles. |
|
|
46
|
-
| [MappingNotRegisteredError](Class.MappingNotRegisteredError) | Thrown when a keyed mapping is requested but not registered. |
|
|
47
|
-
| [MappingProfileBase](Class.MappingProfileBase) | Base class for mapping profiles to simplify implementation. |
|
|
48
|
-
| [MappingService](Class.MappingService) | Central mapping registry supporting keyed & type-based mappings. |
|
|
49
39
|
| [NormalizedUtils](Class.NormalizedUtils) | Utility functions for normalizing data. |
|
|
50
40
|
| [PageableRequest](Class.PageableRequest) | Base class describing pagination query parameters shared across endpoints. |
|
|
51
41
|
| [PageableResponse](Class.PageableResponse) | Base class describing pagination metadata returned alongside list payloads. |
|
|
52
42
|
| [ProblemDetailException](Class.ProblemDetailException) | A NestJS HttpException that represents a Problem Detail as per RFC 7807. |
|
|
53
43
|
| [ProblemDetailExceptionFilter](Class.ProblemDetailExceptionFilter) | A NestJS exception filter that transforms exceptions into Problem Details compliant responses as per RFC 7807. |
|
|
54
44
|
| [QuantityResponse](Class.QuantityResponse) | Base class for quantity responses. |
|
|
55
|
-
| [ResourceManager](Class.ResourceManager) | Central manager for loading resources from various sources. Supports multiple strategies (file, blob, embedded) with caching. |
|
|
56
|
-
| [ResourceModule](Class.ResourceModule) | Module providing the ResourceManager. |
|
|
57
45
|
| [ResponseReturn](Class.ResponseReturn) | - |
|
|
58
46
|
| [SseHub](Class.SseHub) | Represents a server-sent event service. |
|
|
59
47
|
| [SseModule](Class.SseModule) | Represents the `SseModule` class. |
|
|
60
48
|
| [TimeStampResponse](Class.TimeStampResponse) | The base class for all time stamp responses. |
|
|
61
|
-
| [TypeMappingNotRegisteredError](Class.TypeMappingNotRegisteredError) | Thrown when a type mapping is requested but not registered. |
|
|
62
49
|
| [UserAvatarGeneratorService](Class.UserAvatarGeneratorService) | Service for generating GitHub-style identicon avatars. |
|
|
63
50
|
| [UserNameGeneratorService](Class.UserNameGeneratorService) | Random user name generator class |
|
|
64
51
|
| [UUIDGenerator](Class.UUIDGenerator) | UUID Generator class |
|
|
@@ -67,24 +54,12 @@ editUrl: false
|
|
|
67
54
|
|
|
68
55
|
| Interface | Description |
|
|
69
56
|
| ------ | ------ |
|
|
70
|
-
| [IBlobResourceStrategyConfig](Interface.IBlobResourceStrategyConfig) | Configuration for the blob resource strategy. |
|
|
71
|
-
| [IBlobServiceAdapter](Interface.IBlobServiceAdapter) | Minimal blob service interface to avoid circular dependencies. |
|
|
72
57
|
| [IDeviceInfo](Interface.IDeviceInfo) | Interface for parsed device information |
|
|
73
58
|
| [IErrorPageParams](Interface.IErrorPageParams) | Parameters for generating error page content. |
|
|
74
59
|
| [IEventKey](Interface.IEventKey) | Represents a strongly typed event key that encodes the payload type. |
|
|
75
60
|
| [IEventMap](Interface.IEventMap) | Represents the shape of the event map used by the [EventHub](Class.EventHub). |
|
|
76
|
-
| [IFileResourceStrategyConfig](Interface.IFileResourceStrategyConfig) | Configuration for the file resource strategy. |
|
|
77
|
-
| [IHealthCheckResult](Interface.IHealthCheckResult) | Represents the result of a health check indicator. |
|
|
78
|
-
| [IHealthIndicator](Interface.IHealthIndicator) | Defines the contract for a health indicator that can be orchestrated. |
|
|
79
61
|
| [IHostContentParams](Interface.IHostContentParams) | Parameters for generating host content. |
|
|
80
62
|
| [IIdGenerator](Interface.IIdGenerator) | Interface for ID generators |
|
|
81
|
-
| [IMappingBuilder](Interface.IMappingBuilder) | Defines the interface for a mapping builder. |
|
|
82
|
-
| [IMappingKey](Interface.IMappingKey) | Type-safe mapping key that encodes both input and output types. This ensures compile-time type safety when using the mapping service. |
|
|
83
|
-
| [IMappingProfile](Interface.IMappingProfile) | Defines the interface for a mapping profile. |
|
|
84
|
-
| [IResourceManagerConfig](Interface.IResourceManagerConfig) | Configuration for the ResourceManager. |
|
|
85
|
-
| [IResourceMetadata](Interface.IResourceMetadata) | Metadata about a resource. |
|
|
86
|
-
| [IResourceResult](Interface.IResourceResult) | Result of loading a resource. |
|
|
87
|
-
| [IResourceStrategy](Interface.IResourceStrategy) | Strategy for loading resources from a specific source. |
|
|
88
63
|
| [ISseEventData](Interface.ISseEventData) | Represents the data of a Server-Sent Event. |
|
|
89
64
|
| [ISseHub](Interface.ISseHub) | Represents a server-sent event service. |
|
|
90
65
|
|
|
@@ -107,7 +82,6 @@ editUrl: false
|
|
|
107
82
|
| [APP\_URL](Variable.APP_URL) | Base URL the application is served from (e.g. `https://example.com`). |
|
|
108
83
|
| [APP\_VERSION](Variable.APP_VERSION) | Semantic version of the running application (e.g. `1.2.3`). |
|
|
109
84
|
| [GIT\_COMMIT](Variable.GIT_COMMIT) | Git commit SHA of the current build. |
|
|
110
|
-
| [HEALTH\_INDICATORS\_TOKEN](Variable.HEALTH_INDICATORS_TOKEN) | Injection token for registered health indicators |
|
|
111
85
|
| [ID\_GENERATOR\_TOKEN](Variable.ID_GENERATOR_TOKEN) | Interface for ID generators |
|
|
112
86
|
| [IpAddress](Variable.IpAddress) | Extracts the client IP address from the current HTTP request. Handles IPv6 (::1), proxy headers (X-Forwarded-For), and normalizes the output. |
|
|
113
87
|
| [IS\_PUBLIC\_KEY](Variable.IS_PUBLIC_KEY) | - |
|
|
@@ -121,7 +95,6 @@ editUrl: false
|
|
|
121
95
|
| Function | Description |
|
|
122
96
|
| ------ | ------ |
|
|
123
97
|
| [createEventKey](Function.createEventKey) | Creates a branded event key for the [EventHub](Class.EventHub). |
|
|
124
|
-
| [createMappingKey](Function.createMappingKey) | Creates a type-safe mapping key. |
|
|
125
98
|
| [env](Function.env) | Marker function for environment strings. |
|
|
126
99
|
| [getMimeTypeByFileNameOrExtension](Function.getMimeTypeByFileNameOrExtension) | Get MIME type by file name or extension. |
|
|
127
100
|
| [Public](Function.Public) | The `Public` decorator. |
|
|
@@ -10,7 +10,7 @@ package: '@breadstone/archipel-platform-core'
|
|
|
10
10
|
|
|
11
11
|
The foundation library that every other Archipel package depends on. Provides object mapping, template engines, event pub/sub, and shared utilities.
|
|
12
12
|
|
|
13
|
-
> **Note:** Configuration has moved to [`platform-configuration`](../platform-configuration/), caching to [`platform-caching`](../platform-caching/),
|
|
13
|
+
> **Note:** Configuration has moved to [`platform-configuration`](../platform-configuration/), caching to [`platform-caching`](../platform-caching/), cryptography/OTP to [`platform-cryptography`](../platform-cryptography/), mapping to [`platform-mapping`](../platform-mapping/), resource management to [`platform-resources`](../platform-resources/), and health checks to [`platform-health`](../platform-health/). Re-exports are still available from `platform-core` for backward compatibility.
|
|
14
14
|
|
|
15
15
|
**Package:** `@breadstone/archipel-platform-core`
|
|
16
16
|
|
|
@@ -206,6 +206,8 @@ class MyMetricsRecorder implements ICacheMetricsRecorder {
|
|
|
206
206
|
|
|
207
207
|
## Mapping Service
|
|
208
208
|
|
|
209
|
+
> **Extracted:** Mapping functionality now lives in [`platform-mapping`](/packages/platform-mapping/). The imports below still work via backward-compatible re-exports from `platform-core`, but new code should import from `@breadstone/archipel-platform-mapping` directly.
|
|
210
|
+
|
|
209
211
|
Centralized object mapping with type-safe keys and profiles.
|
|
210
212
|
|
|
211
213
|
### Defining Mapping Keys
|
|
@@ -463,6 +465,7 @@ export class OrderService {
|
|
|
463
465
|
| `HostService` | Host configuration (title, logo, features, health endpoints) |
|
|
464
466
|
| `UserAvatarGeneratorService` | Generate deterministic avatars from user identifiers |
|
|
465
467
|
| `UsernameGeneratorService` | Generate random usernames from word lists |
|
|
468
|
+
| `SseHub` | Server-Sent Events hub — bounded to 10,000 event subjects |
|
|
466
469
|
|
|
467
470
|
---
|
|
468
471
|
|
|
@@ -471,12 +474,13 @@ export class OrderService {
|
|
|
471
474
|
| Export | Type | Description |
|
|
472
475
|
| ----------------------- | ------------- | ----------------------------------------------------------------------------------- |
|
|
473
476
|
| `ConfigModule` | NestJS Module | Configuration registration and validation (re-export from `platform-configuration`) |
|
|
474
|
-
| `MappingModule` | NestJS Module | Mapping profile registration
|
|
477
|
+
| `MappingModule` | NestJS Module | Mapping profile registration (re-export from `platform-mapping`) |
|
|
475
478
|
| `EventModule` | NestJS Module | Event pub/sub system |
|
|
476
479
|
| `IdentifierModule` | NestJS Module | ID generation strategy |
|
|
477
480
|
| `HostModule` | NestJS Module | Host services and templates |
|
|
478
|
-
| `HealthModule` | NestJS Module | Health check orchestration
|
|
479
|
-
| `
|
|
481
|
+
| `HealthModule` | NestJS Module | Health check orchestration (re-export from `platform-health`) |
|
|
482
|
+
| `ResourceModule` | NestJS Module | Resource loading strategies (re-export from `platform-resources`) |
|
|
483
|
+
| `MappingService` | Service | Central object mapping (re-export from `platform-mapping`) |
|
|
480
484
|
| `ConfigService` | Service | Type-safe config access (re-export from `platform-configuration`) |
|
|
481
485
|
| `BcryptService` | Service | Password hashing |
|
|
482
486
|
| `CryptoService` | Service | UUID generation |
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: BcryptService
|
|
7
7
|
|
|
8
|
-
Defined in: [BcryptService.ts:
|
|
8
|
+
Defined in: [BcryptService.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/BcryptService.ts#L34)
|
|
9
9
|
|
|
10
10
|
The `BcryptService` class.
|
|
11
11
|
Provides bcrypt hashing and comparison with configurable salt rounds,
|
|
@@ -20,7 +20,7 @@ exceeding bcrypt's 72-byte input limit.
|
|
|
20
20
|
new BcryptService(options?): BcryptService;
|
|
21
21
|
```
|
|
22
22
|
|
|
23
|
-
Defined in: [BcryptService.ts:
|
|
23
|
+
Defined in: [BcryptService.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/BcryptService.ts#L50)
|
|
24
24
|
|
|
25
25
|
Initializes a new instance of the `BcryptService` class.
|
|
26
26
|
|
|
@@ -42,7 +42,7 @@ Initializes a new instance of the `BcryptService` class.
|
|
|
42
42
|
compare(data, encrypted): Promise<boolean>;
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Defined in: [BcryptService.ts:
|
|
45
|
+
Defined in: [BcryptService.ts:92](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/BcryptService.ts#L92)
|
|
46
46
|
|
|
47
47
|
Compares the given data with the encrypted data.
|
|
48
48
|
|
|
@@ -73,7 +73,7 @@ symmetrically with [BcryptService.hash](#hash).
|
|
|
73
73
|
hash(data): Promise<string>;
|
|
74
74
|
```
|
|
75
75
|
|
|
76
|
-
Defined in: [BcryptService.ts:
|
|
76
|
+
Defined in: [BcryptService.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/BcryptService.ts#L71)
|
|
77
77
|
|
|
78
78
|
Hashes the given data using bcrypt with a generated salt.
|
|
79
79
|
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: CryptoService
|
|
7
7
|
|
|
8
|
-
Defined in: [CryptoService.ts:
|
|
8
|
+
Defined in: [CryptoService.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/CryptoService.ts#L16)
|
|
9
9
|
|
|
10
10
|
The `CryptoService` class.
|
|
11
11
|
Represents the service that provides cryptographic operations.
|
|
@@ -18,7 +18,7 @@ Represents the service that provides cryptographic operations.
|
|
|
18
18
|
new CryptoService(): CryptoService;
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [CryptoService.ts:
|
|
21
|
+
Defined in: [CryptoService.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/CryptoService.ts#L22)
|
|
22
22
|
|
|
23
23
|
Initializes a new instance of the `CryptoService` class.
|
|
24
24
|
|
|
@@ -34,7 +34,7 @@ Initializes a new instance of the `CryptoService` class.
|
|
|
34
34
|
getRandomGuid(prefix): string;
|
|
35
35
|
```
|
|
36
36
|
|
|
37
|
-
Defined in: [CryptoService.ts:
|
|
37
|
+
Defined in: [CryptoService.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/CryptoService.ts#L37)
|
|
38
38
|
|
|
39
39
|
Generates a random GUID prefixed with the given string.
|
|
40
40
|
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: OtpService
|
|
7
7
|
|
|
8
|
-
Defined in: [otp/OtpService.ts:
|
|
8
|
+
Defined in: [otp/OtpService.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/OtpService.ts#L45)
|
|
9
9
|
|
|
10
10
|
OTP service implementation backed by otplib v13.
|
|
11
11
|
|
|
@@ -25,7 +25,7 @@ the library version.
|
|
|
25
25
|
new OtpService(options?): OtpService;
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
Defined in: [otp/OtpService.ts:
|
|
28
|
+
Defined in: [otp/OtpService.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/OtpService.ts#L61)
|
|
29
29
|
|
|
30
30
|
Initializes a new instance of the `OtpService` class.
|
|
31
31
|
|
|
@@ -47,7 +47,7 @@ Initializes a new instance of the `OtpService` class.
|
|
|
47
47
|
generateSecret(): string;
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
Defined in: [otp/OtpService.ts:
|
|
50
|
+
Defined in: [otp/OtpService.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/OtpService.ts#L75)
|
|
51
51
|
|
|
52
52
|
Generates a cryptographically random secret suitable for TOTP.
|
|
53
53
|
|
|
@@ -69,7 +69,7 @@ The generated secret string.
|
|
|
69
69
|
generateUri(options): string;
|
|
70
70
|
```
|
|
71
71
|
|
|
72
|
-
Defined in: [otp/OtpService.ts:
|
|
72
|
+
Defined in: [otp/OtpService.ts:80](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/OtpService.ts#L80)
|
|
73
73
|
|
|
74
74
|
Generates an `otpauth://` URI for QR code enrollment.
|
|
75
75
|
|
|
@@ -97,7 +97,7 @@ The formatted `otpauth://` URI.
|
|
|
97
97
|
verify(token, secret): boolean;
|
|
98
98
|
```
|
|
99
99
|
|
|
100
|
-
Defined in: [otp/OtpService.ts:
|
|
100
|
+
Defined in: [otp/OtpService.ts:92](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/OtpService.ts#L92)
|
|
101
101
|
|
|
102
102
|
Verifies a TOTP token against the given secret.
|
|
103
103
|
|
|
@@ -132,7 +132,7 @@ verifyHotp(
|
|
|
132
132
|
counter): Promise<boolean>;
|
|
133
133
|
```
|
|
134
134
|
|
|
135
|
-
Defined in: [otp/OtpService.ts:
|
|
135
|
+
Defined in: [otp/OtpService.ts:99](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/OtpService.ts#L99)
|
|
136
136
|
|
|
137
137
|
Verifies an HOTP (counter-based) token against the given secret and counter.
|
|
138
138
|
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const BCRYPT_OPTIONS: typeof BCRYPT_OPTIONS;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [
|
|
12
|
+
Defined in: [BcryptTokens.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/BcryptTokens.ts#L6)
|
|
13
13
|
|
|
14
|
-
Injection token for
|
|
14
|
+
Injection token for bcrypt options.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const MAX_BCRYPT_PASSWORD_BYTES: 72 = 72;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [BcryptService.ts:
|
|
12
|
+
Defined in: [BcryptService.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/BcryptService.ts#L23)
|
|
13
13
|
|
|
14
14
|
Maximum password byte length that bcrypt processes without truncation.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const MIN_BCRYPT_ROUNDS: 12 = 12;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [BcryptService.ts:
|
|
12
|
+
Defined in: [BcryptService.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/BcryptService.ts#L16)
|
|
13
13
|
|
|
14
14
|
Minimum number of bcrypt salt rounds enforced by the service (OWASP ≥ 12).
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const OTP_OPTIONS: typeof OTP_OPTIONS;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [otp/
|
|
12
|
+
Defined in: [otp/OtpTokens.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/OtpTokens.ts#L6)
|
|
13
13
|
|
|
14
|
-
Injection token for
|
|
14
|
+
Injection token for OTP service options.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const OTP_SERVICE_TOKEN: typeof OTP_SERVICE_TOKEN;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [otp/
|
|
12
|
+
Defined in: [otp/OtpTokens.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/OtpTokens.ts#L13)
|
|
13
13
|
|
|
14
|
-
Injection token for
|
|
14
|
+
Injection token for the OTP service abstraction.
|
|
@@ -9,7 +9,7 @@ editUrl: false
|
|
|
9
9
|
const TOTP_EPOCH_TOLERANCE: 30 = 30;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [otp/OtpService.ts:
|
|
12
|
+
Defined in: [otp/OtpService.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/OtpService.ts#L33)
|
|
13
13
|
|
|
14
14
|
Default TOTP verification tolerance expressed in **seconds** (otplib v13 `epochTolerance`).
|
|
15
15
|
|
|
@@ -29,9 +29,9 @@ editUrl: false
|
|
|
29
29
|
|
|
30
30
|
| Variable | Description |
|
|
31
31
|
| ------ | ------ |
|
|
32
|
-
| [BCRYPT\_OPTIONS](Variable.BCRYPT_OPTIONS) | Injection token for
|
|
32
|
+
| [BCRYPT\_OPTIONS](Variable.BCRYPT_OPTIONS) | Injection token for bcrypt options. |
|
|
33
33
|
| [MAX\_BCRYPT\_PASSWORD\_BYTES](Variable.MAX_BCRYPT_PASSWORD_BYTES) | Maximum password byte length that bcrypt processes without truncation. |
|
|
34
34
|
| [MIN\_BCRYPT\_ROUNDS](Variable.MIN_BCRYPT_ROUNDS) | Minimum number of bcrypt salt rounds enforced by the service (OWASP ≥ 12). |
|
|
35
|
-
| [OTP\_OPTIONS](Variable.OTP_OPTIONS) | Injection token for
|
|
36
|
-
| [OTP\_SERVICE\_TOKEN](Variable.OTP_SERVICE_TOKEN) | Injection token for
|
|
35
|
+
| [OTP\_OPTIONS](Variable.OTP_OPTIONS) | Injection token for OTP service options. |
|
|
36
|
+
| [OTP\_SERVICE\_TOKEN](Variable.OTP_SERVICE_TOKEN) | Injection token for the OTP service abstraction. |
|
|
37
37
|
| [TOTP\_EPOCH\_TOLERANCE](Variable.TOTP_EPOCH_TOLERANCE) | Default TOTP verification tolerance expressed in **seconds** (otplib v13 `epochTolerance`). |
|
|
@@ -125,6 +125,16 @@ The default `TOTP_EPOCH_TOLERANCE` is 30 seconds (±1 time step):
|
|
|
125
125
|
|
|
126
126
|
---
|
|
127
127
|
|
|
128
|
+
## Error Handling
|
|
129
|
+
|
|
130
|
+
`CryptoService` throws `CryptoValidationError` when provided with invalid input (e.g. empty UUID prefix). The error carries a `code` property set to `'CRYPTO_VALIDATION'`.
|
|
131
|
+
|
|
132
|
+
```typescript
|
|
133
|
+
import { CryptoValidationError } from '@breadstone/archipel-platform-cryptography';
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
---
|
|
137
|
+
|
|
128
138
|
## API Reference
|
|
129
139
|
|
|
130
140
|
See the full [API documentation](./api/) for all exported types and classes.
|
|
@@ -10,6 +10,11 @@ Defined in: [renderer/abstracts/BaseDocumentRenderer.ts:18](https://github.com/R
|
|
|
10
10
|
Base class for document renderers.
|
|
11
11
|
Provides common functionality for template loading, parsing, and image processing.
|
|
12
12
|
|
|
13
|
+
## Extended by
|
|
14
|
+
|
|
15
|
+
- [`DocxDocumentRenderer2`](Class.DocxDocumentRenderer2)
|
|
16
|
+
- [`PdfDocumentRenderer`](Class.PdfDocumentRenderer)
|
|
17
|
+
|
|
13
18
|
## Implements
|
|
14
19
|
|
|
15
20
|
- [`IDocumentRenderer`](Interface.IDocumentRenderer)
|
|
@@ -31,13 +36,15 @@ Defined in: [renderer/abstracts/BaseDocumentRenderer.ts:29](https://github.com/R
|
|
|
31
36
|
|
|
32
37
|
| Parameter | Type | Description |
|
|
33
38
|
| ------ | ------ | ------ |
|
|
34
|
-
| `options` | \{ `debug`: `boolean`; `delimiters`: \{ `end`: `string`; `start`: `string`; \}; `maxImageHeight`: `number`; `maxImageWidth`: `number`; \} | - |
|
|
39
|
+
| `options` | \{ `debug`: `boolean`; `delimiters`: \{ `end`: `string`; `start`: `string`; \}; `imageProcessor`: \{ \}; `maxImageHeight`: `number`; `maxImageWidth`: `number`; `renderers`: \{ \}[]; \} | - |
|
|
35
40
|
| `options.debug` | `boolean` | Enable debug logging for document processing pipeline. When enabled, detailed logs will be written for: - Parser strategy selection - Template variable replacements - Data object transformations - Renderer processing steps |
|
|
36
41
|
| `options.delimiters` | \{ `end`: `string`; `start`: `string`; \} | Delimiters for template placeholders. |
|
|
37
42
|
| `options.delimiters.end` | `string` | Ending delimiter. **Default** `']]'` |
|
|
38
43
|
| `options.delimiters.start` | `string` | Starting delimiter. **Default** `'[['` |
|
|
44
|
+
| `options.imageProcessor` | \{ \} | Image processor implementation class. Import from `@breadstone/archipel-platform-documents/sharp` for the default Sharp-based processor. |
|
|
39
45
|
| `options.maxImageHeight` | `number` | Maximum image height in pixels. |
|
|
40
46
|
| `options.maxImageWidth` | `number` | Maximum image width in pixels. |
|
|
47
|
+
| `options.renderers` | \{ \}[] | Document renderer implementation classes. Import from `@breadstone/archipel-platform-documents/docx` and `/pdf` for the built-in renderers. |
|
|
41
48
|
| `resourceManager` | `ResourceManager` | - |
|
|
42
49
|
| `imageProcessor` | [`IImageProcessor`](Interface.IImageProcessor) | - |
|
|
43
50
|
|
|
@@ -66,8 +73,12 @@ protected readonly _options: {
|
|
|
66
73
|
end: string;
|
|
67
74
|
start: string;
|
|
68
75
|
};
|
|
76
|
+
imageProcessor: {
|
|
77
|
+
};
|
|
69
78
|
maxImageHeight: number;
|
|
70
79
|
maxImageWidth: number;
|
|
80
|
+
renderers: {
|
|
81
|
+
}[];
|
|
71
82
|
};
|
|
72
83
|
```
|
|
73
84
|
|
|
@@ -125,6 +136,16 @@ Starting delimiter.
|
|
|
125
136
|
'[['
|
|
126
137
|
```
|
|
127
138
|
|
|
139
|
+
#### imageProcessor
|
|
140
|
+
|
|
141
|
+
```ts
|
|
142
|
+
readonly imageProcessor: {
|
|
143
|
+
};
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
Image processor implementation class.
|
|
147
|
+
Import from `@breadstone/archipel-platform-documents/sharp` for the default Sharp-based processor.
|
|
148
|
+
|
|
128
149
|
#### maxImageHeight
|
|
129
150
|
|
|
130
151
|
```ts
|
|
@@ -141,6 +162,16 @@ readonly maxImageWidth: number;
|
|
|
141
162
|
|
|
142
163
|
Maximum image width in pixels.
|
|
143
164
|
|
|
165
|
+
#### renderers
|
|
166
|
+
|
|
167
|
+
```ts
|
|
168
|
+
readonly renderers: {
|
|
169
|
+
}[];
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
Document renderer implementation classes.
|
|
173
|
+
Import from `@breadstone/archipel-platform-documents/docx` and `/pdf` for the built-in renderers.
|
|
174
|
+
|
|
144
175
|
***
|
|
145
176
|
|
|
146
177
|
### \_resourceManager
|
|
@@ -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:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L19)
|
|
9
9
|
|
|
10
10
|
DocumentEngine orchestrates document generation workflow.
|
|
11
11
|
Coordinates resource loading and renderer components.
|
|
@@ -18,7 +18,7 @@ Coordinates resource loading and renderer components.
|
|
|
18
18
|
new DocumentEngine(resourceManager, renderers): DocumentEngine;
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [engine/DocumentEngine.ts:
|
|
21
|
+
Defined in: [engine/DocumentEngine.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L44)
|
|
22
22
|
|
|
23
23
|
#### Parameters
|
|
24
24
|
|
|
@@ -41,7 +41,7 @@ Defined in: [engine/DocumentEngine.ts:41](https://github.com/RueDeRennes/archipe
|
|
|
41
41
|
get renderers(): ReadonlyMap<string, IDocumentRenderer>;
|
|
42
42
|
```
|
|
43
43
|
|
|
44
|
-
Defined in: [engine/DocumentEngine.ts:
|
|
44
|
+
Defined in: [engine/DocumentEngine.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L36)
|
|
45
45
|
|
|
46
46
|
Get available renderers.
|
|
47
47
|
|
|
@@ -61,7 +61,7 @@ render(options): Promise<IRenderResult & {
|
|
|
61
61
|
}>;
|
|
62
62
|
```
|
|
63
63
|
|
|
64
|
-
Defined in: [engine/DocumentEngine.ts:
|
|
64
|
+
Defined in: [engine/DocumentEngine.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L71)
|
|
65
65
|
|
|
66
66
|
Render a document from template.
|
|
67
67
|
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Abstract Class: DocumentError'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Abstract Class: DocumentError
|
|
7
|
+
|
|
8
|
+
Defined in: [errors/DocumentError.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/errors/DocumentError.ts#L7)
|
|
9
|
+
|
|
10
|
+
Base class for document-related domain errors.
|
|
11
|
+
|
|
12
|
+
## Extends
|
|
13
|
+
|
|
14
|
+
- `Error`
|
|
15
|
+
|
|
16
|
+
## Extended by
|
|
17
|
+
|
|
18
|
+
- [`DocumentRenderError`](Class.DocumentRenderError)
|
|
19
|
+
- [`DocumentValidationError`](Class.DocumentValidationError)
|
|
20
|
+
- [`ImageProcessingError`](Class.ImageProcessingError)
|
|
21
|
+
|
|
22
|
+
## Constructors
|
|
23
|
+
|
|
24
|
+
### Constructor
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
protected new DocumentError(
|
|
28
|
+
message,
|
|
29
|
+
code,
|
|
30
|
+
cause?): DocumentError;
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Defined in: [errors/DocumentError.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/errors/DocumentError.ts#L16)
|
|
34
|
+
|
|
35
|
+
#### Parameters
|
|
36
|
+
|
|
37
|
+
| Parameter | Type |
|
|
38
|
+
| ------ | ------ |
|
|
39
|
+
| `message` | `string` |
|
|
40
|
+
| `code` | `string` |
|
|
41
|
+
| `cause?` | `unknown` |
|
|
42
|
+
|
|
43
|
+
#### Returns
|
|
44
|
+
|
|
45
|
+
`DocumentError`
|
|
46
|
+
|
|
47
|
+
#### Overrides
|
|
48
|
+
|
|
49
|
+
```ts
|
|
50
|
+
Error.constructor
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Properties
|
|
54
|
+
|
|
55
|
+
### code
|
|
56
|
+
|
|
57
|
+
```ts
|
|
58
|
+
readonly code: string;
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Defined in: [errors/DocumentError.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/errors/DocumentError.ts#L10)
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: DocumentModule
|
|
7
7
|
|
|
8
|
-
Defined in: [DocumentModule.ts:
|
|
8
|
+
Defined in: [DocumentModule.ts:73](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/DocumentModule.ts#L73)
|
|
9
9
|
|
|
10
10
|
DocumentModule provides services for document generation and image processing.
|
|
11
11
|
Uses abstract base classes and interfaces for extensibility.
|
|
@@ -30,7 +30,7 @@ new DocumentModule(): DocumentModule;
|
|
|
30
30
|
static forRoot(options): DynamicModule;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [DocumentModule.ts:
|
|
33
|
+
Defined in: [DocumentModule.ts:83](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/DocumentModule.ts#L83)
|
|
34
34
|
|
|
35
35
|
Configures the module with the specified options.
|
|
36
36
|
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Class: DocumentRenderError'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Class: DocumentRenderError
|
|
7
|
+
|
|
8
|
+
Defined in: [errors/DocumentRenderError.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/errors/DocumentRenderError.ts#L8)
|
|
9
|
+
|
|
10
|
+
Thrown when document rendering fails.
|
|
11
|
+
|
|
12
|
+
## Extends
|
|
13
|
+
|
|
14
|
+
- [`DocumentError`](Class.DocumentError)
|
|
15
|
+
|
|
16
|
+
## Constructors
|
|
17
|
+
|
|
18
|
+
### Constructor
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
new DocumentRenderError(message, cause?): DocumentRenderError;
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Defined in: [errors/DocumentRenderError.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/errors/DocumentRenderError.ts#L11)
|
|
25
|
+
|
|
26
|
+
#### Parameters
|
|
27
|
+
|
|
28
|
+
| Parameter | Type |
|
|
29
|
+
| ------ | ------ |
|
|
30
|
+
| `message` | `string` |
|
|
31
|
+
| `cause?` | `unknown` |
|
|
32
|
+
|
|
33
|
+
#### Returns
|
|
34
|
+
|
|
35
|
+
`DocumentRenderError`
|
|
36
|
+
|
|
37
|
+
#### Overrides
|
|
38
|
+
|
|
39
|
+
[`DocumentError`](Class.DocumentError).[`constructor`](Class.DocumentError#constructor)
|
|
40
|
+
|
|
41
|
+
## Properties
|
|
42
|
+
|
|
43
|
+
### code
|
|
44
|
+
|
|
45
|
+
```ts
|
|
46
|
+
readonly code: string;
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Defined in: [errors/DocumentError.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/errors/DocumentError.ts#L10)
|
|
50
|
+
|
|
51
|
+
#### Inherited from
|
|
52
|
+
|
|
53
|
+
[`DocumentError`](Class.DocumentError).[`code`](Class.DocumentError#code)
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Class: DocumentValidationError'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Class: DocumentValidationError
|
|
7
|
+
|
|
8
|
+
Defined in: [errors/DocumentValidationError.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/errors/DocumentValidationError.ts#L8)
|
|
9
|
+
|
|
10
|
+
Thrown when document input validation fails.
|
|
11
|
+
|
|
12
|
+
## Extends
|
|
13
|
+
|
|
14
|
+
- [`DocumentError`](Class.DocumentError)
|
|
15
|
+
|
|
16
|
+
## Constructors
|
|
17
|
+
|
|
18
|
+
### Constructor
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
new DocumentValidationError(message): DocumentValidationError;
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Defined in: [errors/DocumentValidationError.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/errors/DocumentValidationError.ts#L11)
|
|
25
|
+
|
|
26
|
+
#### Parameters
|
|
27
|
+
|
|
28
|
+
| Parameter | Type |
|
|
29
|
+
| ------ | ------ |
|
|
30
|
+
| `message` | `string` |
|
|
31
|
+
|
|
32
|
+
#### Returns
|
|
33
|
+
|
|
34
|
+
`DocumentValidationError`
|
|
35
|
+
|
|
36
|
+
#### Overrides
|
|
37
|
+
|
|
38
|
+
[`DocumentError`](Class.DocumentError).[`constructor`](Class.DocumentError#constructor)
|
|
39
|
+
|
|
40
|
+
## Properties
|
|
41
|
+
|
|
42
|
+
### code
|
|
43
|
+
|
|
44
|
+
```ts
|
|
45
|
+
readonly code: string;
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Defined in: [errors/DocumentError.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/errors/DocumentError.ts#L10)
|
|
49
|
+
|
|
50
|
+
#### Inherited from
|
|
51
|
+
|
|
52
|
+
[`DocumentError`](Class.DocumentError).[`code`](Class.DocumentError#code)
|