@breadstone/archipel-mcp 0.0.7 → 0.0.8

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.
Files changed (104) hide show
  1. package/data/packages/index.md +13 -6
  2. package/data/packages/platform-authentication/api/Class.AppleStrategy.md +1 -1
  3. package/data/packages/platform-authentication/api/Class.AuthModule.md +3 -3
  4. package/data/packages/platform-authentication/api/Class.GithubStrategy.md +1 -1
  5. package/data/packages/platform-authentication/api/Class.GoogleStrategy.md +1 -1
  6. package/data/packages/platform-authentication/api/Class.MicrosoftStrategy.md +1 -1
  7. package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +9 -9
  8. package/data/packages/{platform-core → platform-caching}/api/Class.MemoryLayeredCache.md +41 -33
  9. package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +158 -0
  10. package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +296 -0
  11. package/data/packages/platform-caching/api/Interface.ICacheMetricsRecorder.md +122 -0
  12. package/data/packages/platform-caching/api/Interface.ICacheStats.md +71 -0
  13. package/data/packages/platform-caching/api/Interface.ILayeredCache.md +199 -0
  14. package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +76 -0
  15. package/data/packages/platform-caching/api/Interface.IRedisLayeredCacheOptions.md +122 -0
  16. package/data/packages/platform-caching/api/index.md +25 -0
  17. package/data/packages/platform-caching/index.md +116 -0
  18. package/data/packages/platform-core/api/index.md +104 -150
  19. package/data/packages/platform-core/index.md +5 -3
  20. package/data/packages/platform-cryptography/api/Class.BcryptService.md +73 -0
  21. package/data/packages/platform-cryptography/api/Class.CryptoService.md +52 -0
  22. package/data/packages/{platform-core → platform-cryptography}/api/Class.OtpService.md +8 -4
  23. package/data/packages/{platform-core → platform-cryptography}/api/Interface.IOtpService.md +8 -4
  24. package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md +47 -0
  25. package/data/packages/{platform-core → platform-cryptography}/api/Variable.OTP_SERVICE_TOKEN.md +1 -1
  26. package/data/packages/{platform-core → platform-cryptography}/api/Variable.TOTP_EPOCH_TOLERANCE.md +1 -1
  27. package/data/packages/platform-cryptography/api/index.md +29 -0
  28. package/data/packages/platform-cryptography/index.md +132 -0
  29. package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceCapabilityRegistrarBase.md +7 -5
  30. package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceCapabilityRegistry.md +19 -15
  31. package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceModule.md +1 -1
  32. package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceTextGenerator.md +7 -7
  33. package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +27 -0
  34. package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +27 -0
  35. package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +27 -0
  36. package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +27 -0
  37. package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +27 -0
  38. package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +32 -0
  39. package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +35 -0
  40. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +72 -0
  41. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +71 -0
  42. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +47 -0
  43. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +79 -0
  44. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +47 -0
  45. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +47 -0
  46. package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +73 -0
  47. package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +36 -0
  48. package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +71 -0
  49. package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +59 -0
  50. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +47 -0
  51. package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +47 -0
  52. package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +35 -0
  53. package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +71 -0
  54. package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +35 -0
  55. package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +35 -0
  56. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +35 -0
  57. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +95 -0
  58. package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +35 -0
  59. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +61 -0
  60. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +47 -0
  61. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +54 -0
  62. package/data/packages/{platform-core → platform-intelligence}/api/TypeAlias.IntelligenceConversationMessageRole.md +1 -1
  63. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +25 -0
  64. package/data/packages/{platform-core → platform-intelligence}/api/TypeAlias.IntelligenceProviderName.md +1 -1
  65. package/data/packages/{platform-core → platform-intelligence}/api/Variable.IntelligenceConversationMessageRoles.md +6 -6
  66. package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +29 -0
  67. package/data/packages/platform-intelligence/api/index.md +70 -0
  68. package/data/packages/platform-intelligence/index.md +131 -0
  69. package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +15 -15
  70. package/package.json +1 -1
  71. package/data/packages/platform-core/api/Class.BcryptService.md +0 -69
  72. package/data/packages/platform-core/api/Class.CryptoService.md +0 -50
  73. package/data/packages/platform-core/api/Class.NoopCacheMetricsRecorder.md +0 -157
  74. package/data/packages/platform-core/api/Class.RedisLayeredCache.md +0 -275
  75. package/data/packages/platform-core/api/Interface.ICacheMetricsRecorder.md +0 -121
  76. package/data/packages/platform-core/api/Interface.ICacheStats.md +0 -71
  77. package/data/packages/platform-core/api/Interface.IIntelligenceArtifact.md +0 -31
  78. package/data/packages/platform-core/api/Interface.IIntelligenceCapability.md +0 -62
  79. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityMetadata.md +0 -61
  80. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityPayload.md +0 -41
  81. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityRegistry.md +0 -69
  82. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityResult.md +0 -41
  83. package/data/packages/platform-core/api/Interface.IIntelligenceCompletionUsage.md +0 -41
  84. package/data/packages/platform-core/api/Interface.IIntelligenceContext.md +0 -63
  85. package/data/packages/platform-core/api/Interface.IIntelligenceContextBuilder.md +0 -32
  86. package/data/packages/platform-core/api/Interface.IIntelligenceConversationMessageSnapshot.md +0 -61
  87. package/data/packages/platform-core/api/Interface.IIntelligenceConversationSnapshot.md +0 -51
  88. package/data/packages/platform-core/api/Interface.IIntelligenceFollowUpQuestion.md +0 -41
  89. package/data/packages/platform-core/api/Interface.IIntelligenceIntent.md +0 -41
  90. package/data/packages/platform-core/api/Interface.IIntelligenceIntentEntity.md +0 -31
  91. package/data/packages/platform-core/api/Interface.IIntelligenceMessageModel.md +0 -61
  92. package/data/packages/platform-core/api/Interface.IIntelligenceMessagePayload.md +0 -31
  93. package/data/packages/platform-core/api/Interface.IIntelligencePrompt.md +0 -31
  94. package/data/packages/platform-core/api/Interface.IIntelligencePromptMessage.md +0 -31
  95. package/data/packages/platform-core/api/Interface.IIntelligenceProviderConfiguration.md +0 -81
  96. package/data/packages/platform-core/api/Interface.IIntelligenceResponseMessage.md +0 -31
  97. package/data/packages/platform-core/api/Interface.IIntelligenceTextCompletion.md +0 -53
  98. package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerationOptions.md +0 -41
  99. package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerator.md +0 -46
  100. package/data/packages/platform-core/api/Interface.ILayeredCache.md +0 -194
  101. package/data/packages/platform-core/api/Interface.ILayeredCacheOptions.md +0 -71
  102. package/data/packages/platform-core/api/Interface.IOtpUriOptions.md +0 -47
  103. package/data/packages/platform-core/api/Interface.IRedisLayeredCacheOptions.md +0 -108
  104. package/data/packages/platform-core/api/Variable.IntelligenceProviderNames.md +0 -29
package/data/packages/platform-core/api/index.md CHANGED
@@ -14,165 +14,119 @@ editUrl: false
14
14
 
15
15
  ## Classes
16
16
 
17
- | Class | Description |
18
- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
19
- | [AppHealthIndicator](Class.AppHealthIndicator) | Health indicator for the application. |
20
- | [BcryptService](Class.BcryptService) | The `BcryptService` class. Represents the service that provides bcrypt operations. |
21
- | [BlobResourceStrategy](Class.BlobResourceStrategy) | Strategy for loading resources from blob storage. |
22
- | [BooleanUtils](Class.BooleanUtils) | Boolean Utility Class. This class provides static methods to parse and format boolean values. |
23
- | [CasingInterceptor](Class.CasingInterceptor) | This interceptor is responsible for converting snake_case or other casing styles in the request body to camelCase before passing them to controllers. It also handles the transformation of the response if needed. |
24
- | [CatchUtils](Class.CatchUtils) | - |
25
- | [ConfigModule](Class.ConfigModule) | The `ConfigModule` class. |
26
- | [ConfigRegistry](Class.ConfigRegistry) | A static, global registry that collects all configuration keys registered by platform libraries. This enables a central overview of every environment variable the application depends on, grouped by source module. |
27
- | [ConfigService](Class.ConfigService) | - |
28
- | [ConfigStrategyBase](Class.ConfigStrategyBase) | The `ConfigStrategyBase` class. Represents the base class for configuration strategies. |
29
- | [ContentTemplateEngine](Class.ContentTemplateEngine) | The `ContentTemplateEngine` class. |
30
- | [CryptoService](Class.CryptoService) | The `CryptoService` class. Represents the service that provides cryptographic operations. |
31
- | [CUIDGenerator](Class.CUIDGenerator) | CUID Generator class |
32
- | [DateTimeUtils](Class.DateTimeUtils) | TimeSpan Utility Class. Provides methods to parse and format time span values. |
33
- | [DeviceParserService](Class.DeviceParserService) | The `DeviceParserService` class. |
34
- | [EmbeddedResourceStrategy](Class.EmbeddedResourceStrategy) | Strategy for loading embedded resources from memory. |
35
- | [EnvironmentConfigStrategy](Class.EnvironmentConfigStrategy) | The `EnvironmentConfigStrategy` class. |
36
- | [ErrorTemplateService](Class.ErrorTemplateService) | Service for rendering error page templates. |
37
- | [EventHub](Class.EventHub) | Provides a strongly typed event hub that can publish and subscribe to events. |
38
- | [EventModule](Class.EventModule) | Module that provides event hub services. |
39
- | [FileConfigStrategy](Class.FileConfigStrategy) | The `FileConfigStrategy` class. |
40
- | [FileResourceStrategy](Class.FileResourceStrategy) | Strategy for loading resources from the local file system. |
41
- | [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. |
42
- | [GUIDGenerator](Class.GUIDGenerator) | GUID Generator class |
43
- | [HealthModule](Class.HealthModule) | - |
44
- | [HealthOrchestrator](Class.HealthOrchestrator) | Orchestrates execution of all registered health indicators and aggregates their results. |
45
- | [HostModule](Class.HostModule) | The `HostModule` provides host-related services globally. |
46
- | [HostService](Class.HostService) | The `HostService` class. |
47
- | [HttpLoggerMiddleware](Class.HttpLoggerMiddleware) | - |
48
- | [IdentifierModule](Class.IdentifierModule) | - |
49
- | [IdGeneratorBase](Class.IdGeneratorBase) | Abstract base class for ID Generators |
50
- | [IntelligenceCapabilityRegistrarBase](Class.IntelligenceCapabilityRegistrarBase) | Provides a reusable registration flow that allows feature modules to contribute capabilities to the global intelligence registry while keeping their implementation details private. |
51
- | [IntelligenceCapabilityRegistry](Class.IntelligenceCapabilityRegistry) | Central registry responsible for resolving intelligence capabilities based on intent metadata. |
52
- | [IntelligenceModule](Class.IntelligenceModule) | Core module exposing the shared intelligence infrastructure to feature modules. |
53
- | [IntelligenceTextGenerator](Class.IntelligenceTextGenerator) | Executes text completions using the configured intelligence provider. |
54
- | [LimitRequestSizeMiddleware](Class.LimitRequestSizeMiddleware) | - |
55
- | [LocalizedTextRequest](Class.LocalizedTextRequest) | Request DTO for a single localized text entry. |
56
- | [LocalizedTextResponse](Class.LocalizedTextResponse) | Base class for localized text responses. |
57
- | [MappingBuilder](Class.MappingBuilder) | A mapping builder that uses the mapping service to register maps. |
58
- | [MappingModule](Class.MappingModule) | Module that provides mapping services and allows registration of mapping profiles. |
59
- | [MappingNotRegisteredError](Class.MappingNotRegisteredError) | Thrown when a keyed mapping is requested but not registered. |
60
- | [MappingProfileBase](Class.MappingProfileBase) | Base class for mapping profiles to simplify implementation. |
61
- | [MappingService](Class.MappingService) | Central mapping registry supporting keyed & type-based mappings. |
62
- | [MemoryLayeredCache](Class.MemoryLayeredCache) | In-memory layered cache implementation. |
63
- | [NoopCacheMetricsRecorder](Class.NoopCacheMetricsRecorder) | No-op implementation used when no metrics backend is configured. |
64
- | [NormalizedUtils](Class.NormalizedUtils) | Utility functions for normalizing data. |
65
- | [OtpService](Class.OtpService) | OTP service implementation backed by otplib v13. |
66
- | [PageableRequest](Class.PageableRequest) | Base class describing pagination query parameters shared across endpoints. |
67
- | [PageableResponse](Class.PageableResponse) | Base class describing pagination metadata returned alongside list payloads. |
68
- | [ProblemDetailException](Class.ProblemDetailException) | A NestJS HttpException that represents a Problem Detail as per RFC 7807. |
69
- | [ProblemDetailExceptionFilter](Class.ProblemDetailExceptionFilter) | A NestJS exception filter that transforms exceptions into Problem Details compliant responses as per RFC 7807. |
70
- | [QuantityResponse](Class.QuantityResponse) | Base class for quantity responses. |
71
- | [RedisLayeredCache](Class.RedisLayeredCache) | Generic layered cache contract (DB first, then memory, then external fetcher). |
72
- | [ResourceManager](Class.ResourceManager) | Central manager for loading resources from various sources. Supports multiple strategies (file, blob, embedded) with caching. |
73
- | [ResourceModule](Class.ResourceModule) | Module providing the ResourceManager. |
74
- | [ResponseReturn](Class.ResponseReturn) | - |
75
- | [SseHub](Class.SseHub) | Represents a server-sent event service. |
76
- | [SseModule](Class.SseModule) | Represents the `SseModule` class. |
77
- | [TimeStampResponse](Class.TimeStampResponse) | The base class for all time stamp responses. |
78
- | [TypeMappingNotRegisteredError](Class.TypeMappingNotRegisteredError) | Thrown when a type mapping is requested but not registered. |
79
- | [UserAvatarGeneratorService](Class.UserAvatarGeneratorService) | Service for generating GitHub-style identicon avatars. |
80
- | [UserNameGeneratorService](Class.UserNameGeneratorService) | Random user name generator class |
81
- | [UUIDGenerator](Class.UUIDGenerator) | UUID Generator class |
17
+ | Class | Description |
18
+ | -------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
19
+ | [AppHealthIndicator](Class.AppHealthIndicator) | Health indicator for the application. |
20
+ | [BlobResourceStrategy](Class.BlobResourceStrategy) | Strategy for loading resources from blob storage. |
21
+ | [BooleanUtils](Class.BooleanUtils) | Boolean Utility Class. This class provides static methods to parse and format boolean values. |
22
+ | [CasingInterceptor](Class.CasingInterceptor) | This interceptor is responsible for converting snake_case or other casing styles in the request body to camelCase before passing them to controllers. It also handles the transformation of the response if needed. |
23
+ | [CatchUtils](Class.CatchUtils) | - |
24
+ | [ConfigModule](Class.ConfigModule) | The `ConfigModule` class. |
25
+ | [ConfigRegistry](Class.ConfigRegistry) | A static, global registry that collects all configuration keys registered by platform libraries. This enables a central overview of every environment variable the application depends on, grouped by source module. |
26
+ | [ConfigService](Class.ConfigService) | - |
27
+ | [ConfigStrategyBase](Class.ConfigStrategyBase) | The `ConfigStrategyBase` class. Represents the base class for configuration strategies. |
28
+ | [ContentTemplateEngine](Class.ContentTemplateEngine) | The `ContentTemplateEngine` class. |
29
+ | [CUIDGenerator](Class.CUIDGenerator) | CUID Generator class |
30
+ | [DateTimeUtils](Class.DateTimeUtils) | TimeSpan Utility Class. Provides methods to parse and format time span values. |
31
+ | [DeviceParserService](Class.DeviceParserService) | The `DeviceParserService` class. |
32
+ | [EmbeddedResourceStrategy](Class.EmbeddedResourceStrategy) | Strategy for loading embedded resources from memory. |
33
+ | [EnvironmentConfigStrategy](Class.EnvironmentConfigStrategy) | The `EnvironmentConfigStrategy` class. |
34
+ | [ErrorTemplateService](Class.ErrorTemplateService) | Service for rendering error page templates. |
35
+ | [EventHub](Class.EventHub) | Provides a strongly typed event hub that can publish and subscribe to events. |
36
+ | [EventModule](Class.EventModule) | Module that provides event hub services. |
37
+ | [FileConfigStrategy](Class.FileConfigStrategy) | The `FileConfigStrategy` class. |
38
+ | [FileResourceStrategy](Class.FileResourceStrategy) | Strategy for loading resources from the local file system. |
39
+ | [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. |
40
+ | [GUIDGenerator](Class.GUIDGenerator) | GUID Generator class |
41
+ | [HealthModule](Class.HealthModule) | - |
42
+ | [HealthOrchestrator](Class.HealthOrchestrator) | Orchestrates execution of all registered health indicators and aggregates their results. |
43
+ | [HostModule](Class.HostModule) | The `HostModule` provides host-related services globally. |
44
+ | [HostService](Class.HostService) | The `HostService` class. |
45
+ | [HttpLoggerMiddleware](Class.HttpLoggerMiddleware) | - |
46
+ | [IdentifierModule](Class.IdentifierModule) | - |
47
+ | [IdGeneratorBase](Class.IdGeneratorBase) | Abstract base class for ID Generators |
48
+ | [LimitRequestSizeMiddleware](Class.LimitRequestSizeMiddleware) | - |
49
+ | [LocalizedTextRequest](Class.LocalizedTextRequest) | Request DTO for a single localized text entry. |
50
+ | [LocalizedTextResponse](Class.LocalizedTextResponse) | Base class for localized text responses. |
51
+ | [MappingBuilder](Class.MappingBuilder) | A mapping builder that uses the mapping service to register maps. |
52
+ | [MappingModule](Class.MappingModule) | Module that provides mapping services and allows registration of mapping profiles. |
53
+ | [MappingNotRegisteredError](Class.MappingNotRegisteredError) | Thrown when a keyed mapping is requested but not registered. |
54
+ | [MappingProfileBase](Class.MappingProfileBase) | Base class for mapping profiles to simplify implementation. |
55
+ | [MappingService](Class.MappingService) | Central mapping registry supporting keyed & type-based mappings. |
56
+ | [NormalizedUtils](Class.NormalizedUtils) | Utility functions for normalizing data. |
57
+ | [PageableRequest](Class.PageableRequest) | Base class describing pagination query parameters shared across endpoints. |
58
+ | [PageableResponse](Class.PageableResponse) | Base class describing pagination metadata returned alongside list payloads. |
59
+ | [ProblemDetailException](Class.ProblemDetailException) | A NestJS HttpException that represents a Problem Detail as per RFC 7807. |
60
+ | [ProblemDetailExceptionFilter](Class.ProblemDetailExceptionFilter) | A NestJS exception filter that transforms exceptions into Problem Details compliant responses as per RFC 7807. |
61
+ | [QuantityResponse](Class.QuantityResponse) | Base class for quantity responses. |
62
+ | [ResourceManager](Class.ResourceManager) | Central manager for loading resources from various sources. Supports multiple strategies (file, blob, embedded) with caching. |
63
+ | [ResourceModule](Class.ResourceModule) | Module providing the ResourceManager. |
64
+ | [ResponseReturn](Class.ResponseReturn) | - |
65
+ | [SseHub](Class.SseHub) | Represents a server-sent event service. |
66
+ | [SseModule](Class.SseModule) | Represents the `SseModule` class. |
67
+ | [TimeStampResponse](Class.TimeStampResponse) | The base class for all time stamp responses. |
68
+ | [TypeMappingNotRegisteredError](Class.TypeMappingNotRegisteredError) | Thrown when a type mapping is requested but not registered. |
69
+ | [UserAvatarGeneratorService](Class.UserAvatarGeneratorService) | Service for generating GitHub-style identicon avatars. |
70
+ | [UserNameGeneratorService](Class.UserNameGeneratorService) | Random user name generator class |
71
+ | [UUIDGenerator](Class.UUIDGenerator) | UUID Generator class |
82
72
 
83
73
  ## Interfaces
84
74
 
85
- | Interface | Description |
86
- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
87
- | [IBlobResourceStrategyConfig](Interface.IBlobResourceStrategyConfig) | Configuration for the blob resource strategy. |
88
- | [IBlobServiceAdapter](Interface.IBlobServiceAdapter) | Minimal blob service interface to avoid circular dependencies. |
89
- | [ICacheMetricsRecorder](Interface.ICacheMetricsRecorder) | Metrics recorder for cache operations. Implementations can forward to Prometheus, OpenTelemetry, etc. |
90
- | [ICacheStats](Interface.ICacheStats) | Cache statistics. |
91
- | [IConfigKey](Interface.IConfigKey) | A type-safe config key that encodes both the config key and the type of its value. |
92
- | [IConfigModuleOptions](Interface.IConfigModuleOptions) | The `IConfigModuleOptions` interface. |
93
- | [IConfigRegistryEntry](Interface.IConfigRegistryEntry) | Describes a registered configuration entry, including its source module and whether the entry is required or optional (with a default value). |
94
- | [IDeviceInfo](Interface.IDeviceInfo) | Interface for parsed device information |
95
- | [IErrorPageParams](Interface.IErrorPageParams) | Parameters for generating error page content. |
96
- | [IEventKey](Interface.IEventKey) | Represents a strongly typed event key that encodes the payload type. |
97
- | [IEventMap](Interface.IEventMap) | Represents the shape of the event map used by the [EventHub](Class.EventHub). |
98
- | [IFileResourceStrategyConfig](Interface.IFileResourceStrategyConfig) | Configuration for the file resource strategy. |
99
- | [IHealthCheckResult](Interface.IHealthCheckResult) | Represents the result of a health check indicator. |
100
- | [IHealthIndicator](Interface.IHealthIndicator) | Defines the contract for a health indicator that can be orchestrated. |
101
- | [IHostContentParams](Interface.IHostContentParams) | Parameters for generating host content. |
102
- | [IIdGenerator](Interface.IIdGenerator) | Interface for ID generators |
103
- | [IIntelligenceArtifact](Interface.IIntelligenceArtifact) | Represents a structured artifact returned by a capability. |
104
- | [IIntelligenceCapability](Interface.IIntelligenceCapability) | Abstraction implemented by all capability providers. |
105
- | [IIntelligenceCapabilityMetadata](Interface.IIntelligenceCapabilityMetadata) | Metadata describing a capability for orchestration and analytics purposes. |
106
- | [IIntelligenceCapabilityPayload](Interface.IIntelligenceCapabilityPayload) | Payload forwarded to capabilities for execution. |
107
- | [IIntelligenceCapabilityRegistry](Interface.IIntelligenceCapabilityRegistry) | Registry abstraction responsible for resolving capabilities. |
108
- | [IIntelligenceCapabilityResult](Interface.IIntelligenceCapabilityResult) | Represents the outcome produced by a capability execution. |
109
- | [IIntelligenceCompletionUsage](Interface.IIntelligenceCompletionUsage) | Captures usage telemetry returned by the intelligence provider. |
110
- | [IIntelligenceContext](Interface.IIntelligenceContext) | Describes the context aggregated before routing a request to a capability. |
111
- | [IIntelligenceContextBuilder](Interface.IIntelligenceContextBuilder) | Responsible for composing the context supplied to capabilities. |
112
- | [IIntelligenceConversationMessageSnapshot](Interface.IIntelligenceConversationMessageSnapshot) | Represents a single message returned within a conversation snapshot. |
113
- | [IIntelligenceConversationSnapshot](Interface.IIntelligenceConversationSnapshot) | Represents a lightweight snapshot of a conversation used for context building. |
114
- | [IIntelligenceFollowUpQuestion](Interface.IIntelligenceFollowUpQuestion) | Represents a follow-up question suggested to keep the dialogue active. |
115
- | [IIntelligenceIntent](Interface.IIntelligenceIntent) | Represents the structured intent resolved from a user message. |
116
- | [IIntelligenceIntentEntity](Interface.IIntelligenceIntentEntity) | Represents an entity extracted from a resolved intelligence intent. |
117
- | [IIntelligenceMessageModel](Interface.IIntelligenceMessageModel) | Represents a normalized message stored in persistence. |
118
- | [IIntelligenceMessagePayload](Interface.IIntelligenceMessagePayload) | Carries the payload submitted when messaging the intelligence entrypoint. |
119
- | [IIntelligencePrompt](Interface.IIntelligencePrompt) | Represents the input supplied to the intelligence text generator. |
120
- | [IIntelligencePromptMessage](Interface.IIntelligencePromptMessage) | Describes a normalized message used for text generation prompts. |
121
- | [IIntelligenceProviderConfiguration](Interface.IIntelligenceProviderConfiguration) | Describes the resolved configuration for the intelligence provider. |
122
- | [IIntelligenceResponseMessage](Interface.IIntelligenceResponseMessage) | Represents a single assistant message returned by a capability. |
123
- | [IIntelligenceTextCompletion](Interface.IIntelligenceTextCompletion) | Represents the normalized completion result produced by the intelligence provider. |
124
- | [IIntelligenceTextGenerationOptions](Interface.IIntelligenceTextGenerationOptions) | Options that can be supplied when generating text with the intelligence provider. |
125
- | [IIntelligenceTextGenerator](Interface.IIntelligenceTextGenerator) | Abstraction responsible for executing text completions using the configured provider. |
126
- | [ILayeredCache](Interface.ILayeredCache) | Generic layered cache contract (DB first, then memory, then external fetcher). |
127
- | [ILayeredCacheOptions](Interface.ILayeredCacheOptions) | In-memory layered cache: memory (LRU+TTL+SWR) + async loader fallback. |
128
- | [IMappingBuilder](Interface.IMappingBuilder) | Defines the interface for a mapping builder. |
129
- | [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. |
130
- | [IMappingProfile](Interface.IMappingProfile) | Defines the interface for a mapping profile. |
131
- | [IOtpService](Interface.IOtpService) | Abstraction over OTP (One-Time Password) operations. |
132
- | [IOtpUriOptions](Interface.IOtpUriOptions) | Options for generating an OTP authentication URI (otpauth://). |
133
- | [IRedisLayeredCacheOptions](Interface.IRedisLayeredCacheOptions) | Skeleton Redis-backed cache (placeholder; implement ioredis logic later). Provides same contract as in-memory layered cache; currently delegates to provided loader only. |
134
- | [IResourceManagerConfig](Interface.IResourceManagerConfig) | Configuration for the ResourceManager. |
135
- | [IResourceMetadata](Interface.IResourceMetadata) | Metadata about a resource. |
136
- | [IResourceResult](Interface.IResourceResult) | Result of loading a resource. |
137
- | [IResourceStrategy](Interface.IResourceStrategy) | Strategy for loading resources from a specific source. |
138
- | [ISseEventData](Interface.ISseEventData) | Represents the data of a Server-Sent Event. |
139
- | [ISseHub](Interface.ISseHub) | Represents a server-sent event service. |
75
+ | Interface | Description |
76
+ | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
77
+ | [IBlobResourceStrategyConfig](Interface.IBlobResourceStrategyConfig) | Configuration for the blob resource strategy. |
78
+ | [IBlobServiceAdapter](Interface.IBlobServiceAdapter) | Minimal blob service interface to avoid circular dependencies. |
79
+ | [IConfigKey](Interface.IConfigKey) | A type-safe config key that encodes both the config key and the type of its value. |
80
+ | [IConfigModuleOptions](Interface.IConfigModuleOptions) | The `IConfigModuleOptions` interface. |
81
+ | [IConfigRegistryEntry](Interface.IConfigRegistryEntry) | Describes a registered configuration entry, including its source module and whether the entry is required or optional (with a default value). |
82
+ | [IDeviceInfo](Interface.IDeviceInfo) | Interface for parsed device information |
83
+ | [IErrorPageParams](Interface.IErrorPageParams) | Parameters for generating error page content. |
84
+ | [IEventKey](Interface.IEventKey) | Represents a strongly typed event key that encodes the payload type. |
85
+ | [IEventMap](Interface.IEventMap) | Represents the shape of the event map used by the [EventHub](Class.EventHub). |
86
+ | [IFileResourceStrategyConfig](Interface.IFileResourceStrategyConfig) | Configuration for the file resource strategy. |
87
+ | [IHealthCheckResult](Interface.IHealthCheckResult) | Represents the result of a health check indicator. |
88
+ | [IHealthIndicator](Interface.IHealthIndicator) | Defines the contract for a health indicator that can be orchestrated. |
89
+ | [IHostContentParams](Interface.IHostContentParams) | Parameters for generating host content. |
90
+ | [IIdGenerator](Interface.IIdGenerator) | Interface for ID generators |
91
+ | [IMappingBuilder](Interface.IMappingBuilder) | Defines the interface for a mapping builder. |
92
+ | [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. |
93
+ | [IMappingProfile](Interface.IMappingProfile) | Defines the interface for a mapping profile. |
94
+ | [IResourceManagerConfig](Interface.IResourceManagerConfig) | Configuration for the ResourceManager. |
95
+ | [IResourceMetadata](Interface.IResourceMetadata) | Metadata about a resource. |
96
+ | [IResourceResult](Interface.IResourceResult) | Result of loading a resource. |
97
+ | [IResourceStrategy](Interface.IResourceStrategy) | Strategy for loading resources from a specific source. |
98
+ | [ISseEventData](Interface.ISseEventData) | Represents the data of a Server-Sent Event. |
99
+ | [ISseHub](Interface.ISseHub) | Represents a server-sent event service. |
140
100
 
141
101
  ## Type Aliases
142
102
 
143
- | Type Alias | Description |
144
- | ------------------------------------------------------------------------------------ | --------------------------------------------------------------------------- |
145
- | [CamelCase](TypeAlias.CamelCase) | - |
146
- | [IntelligenceConversationMessageRole](TypeAlias.IntelligenceConversationMessageRole) | Represents the union of supported conversation message roles. |
147
- | [IntelligenceProviderName](TypeAlias.IntelligenceProviderName) | Represents the union of supported intelligence provider identifiers. |
148
- | [ProblemDetail](TypeAlias.ProblemDetail) | A Problem Detail object as per RFC 7807. |
149
- | [ProblemDetailTypeUrlResolver](TypeAlias.ProblemDetailTypeUrlResolver) | A function that resolves a type URL for a given HTTP status code and title. |
150
- | [SetOptional](TypeAlias.SetOptional) | Sets the specified keys of T as optional. |
151
- | [StringValue](TypeAlias.StringValue) | - |
103
+ | Type Alias | Description |
104
+ | ---------------------------------------------------------------------- | --------------------------------------------------------------------------- |
105
+ | [CamelCase](TypeAlias.CamelCase) | - |
106
+ | [ProblemDetail](TypeAlias.ProblemDetail) | A Problem Detail object as per RFC 7807. |
107
+ | [ProblemDetailTypeUrlResolver](TypeAlias.ProblemDetailTypeUrlResolver) | A function that resolves a type URL for a given HTTP status code and title. |
108
+ | [SetOptional](TypeAlias.SetOptional) | Sets the specified keys of T as optional. |
109
+ | [StringValue](TypeAlias.StringValue) | - |
152
110
 
153
111
  ## Variables
154
112
 
155
- | Variable | Description |
156
- | ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
157
- | [APP_PORT](Variable.APP_PORT) | HTTP port the application listens on. |
158
- | [APP_URL](Variable.APP_URL) | Base URL the application is served from (e.g. `https://example.com`). |
159
- | [APP_VERSION](Variable.APP_VERSION) | Semantic version of the running application (e.g. `1.2.3`). |
160
- | [HEALTH_INDICATORS_TOKEN](Variable.HEALTH_INDICATORS_TOKEN) | Injection token for registered health indicators |
161
- | [ID_GENERATOR_TOKEN](Variable.ID_GENERATOR_TOKEN) | Interface for ID generators |
162
- | [INTELLIGENCE_MAX_OUTPUT_TOKENS](Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS) | Maximum number of output tokens for the AI model. |
163
- | [INTELLIGENCE_MODEL](Variable.INTELLIGENCE_MODEL) | AI model identifier to use for text generation. |
164
- | [INTELLIGENCE_TEMPERATURE](Variable.INTELLIGENCE_TEMPERATURE) | Sampling temperature for the AI model. |
165
- | [INTELLIGENCE_TOP_P](Variable.INTELLIGENCE_TOP_P) | Top-p (nucleus sampling) for the AI model. |
166
- | [IntelligenceConversationMessageRoles](Variable.IntelligenceConversationMessageRoles) | Enumerates the conversation roles used for contextual snapshots and messages. |
167
- | [IntelligenceProviderNames](Variable.IntelligenceProviderNames) | Enumerates the supported model providers powering the intelligence pipeline. |
168
- | [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. |
169
- | [IS_PUBLIC_KEY](Variable.IS_PUBLIC_KEY) | - |
170
- | [Lang](Variable.Lang) | Extracts the first language token from the Accept-Language header. |
171
- | [NODE_ENV](Variable.NODE_ENV) | The current Node.js environment (`development`, `production`, etc.). |
172
- | [OTP_SERVICE_TOKEN](Variable.OTP_SERVICE_TOKEN) | Injection token for [IOtpService](Interface.IOtpService). |
173
- | [PLATFORM_CORE_CONFIG_ENTRIES](Variable.PLATFORM_CORE_CONFIG_ENTRIES) | All configuration entries required by `platform-core`. |
174
- | [TOTP_EPOCH_TOLERANCE](Variable.TOTP_EPOCH_TOLERANCE) | TOTP verification tolerance expressed in **seconds** (otplib v13 `epochTolerance`). |
175
- | [UserAgent](Variable.UserAgent) | Extracts the User-Agent header from the incoming HTTP request. |
113
+ | Variable | Description |
114
+ | ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
115
+ | [APP_PORT](Variable.APP_PORT) | HTTP port the application listens on. |
116
+ | [APP_URL](Variable.APP_URL) | Base URL the application is served from (e.g. `https://example.com`). |
117
+ | [APP_VERSION](Variable.APP_VERSION) | Semantic version of the running application (e.g. `1.2.3`). |
118
+ | [HEALTH_INDICATORS_TOKEN](Variable.HEALTH_INDICATORS_TOKEN) | Injection token for registered health indicators |
119
+ | [ID_GENERATOR_TOKEN](Variable.ID_GENERATOR_TOKEN) | Interface for ID generators |
120
+ | [INTELLIGENCE_MAX_OUTPUT_TOKENS](Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS) | Maximum number of output tokens for the AI model. |
121
+ | [INTELLIGENCE_MODEL](Variable.INTELLIGENCE_MODEL) | AI model identifier to use for text generation. |
122
+ | [INTELLIGENCE_TEMPERATURE](Variable.INTELLIGENCE_TEMPERATURE) | Sampling temperature for the AI model. |
123
+ | [INTELLIGENCE_TOP_P](Variable.INTELLIGENCE_TOP_P) | Top-p (nucleus sampling) for the AI model. |
124
+ | [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. |
125
+ | [IS_PUBLIC_KEY](Variable.IS_PUBLIC_KEY) | - |
126
+ | [Lang](Variable.Lang) | Extracts the first language token from the Accept-Language header. |
127
+ | [NODE_ENV](Variable.NODE_ENV) | The current Node.js environment (`development`, `production`, etc.). |
128
+ | [PLATFORM_CORE_CONFIG_ENTRIES](Variable.PLATFORM_CORE_CONFIG_ENTRIES) | All configuration entries required by `platform-core`. |
129
+ | [UserAgent](Variable.UserAgent) | Extracts the User-Agent header from the incoming HTTP request. |
176
130
 
177
131
  ## Functions
178
132
 
package/data/packages/platform-core/index.md CHANGED
@@ -1,14 +1,16 @@
1
1
  ---
2
2
  title: platform-core
3
- description: Foundation library providing caching, configuration, cryptography, mapping, templates, and shared utilities.
3
+ description: Foundation library providing configuration, mapping, templates, event pub/sub, and shared utilities.
4
4
  order: 1
5
- tags: [core, caching, config, mapping, crypto, otp, templates]
5
+ tags: [core, config, mapping, templates, event-hub]
6
6
  package: '@breadstone/archipel-platform-core'
7
7
  ---
8
8
 
9
9
  # platform-core
10
10
 
11
- The foundation library that every other Archipel package depends on. Provides caching, configuration management, cryptography, object mapping, template engines, event pub/sub, and shared utilities.
11
+ The foundation library that every other Archipel package depends on. Provides configuration management, object mapping, template engines, event pub/sub, and shared utilities.
12
+
13
+ > **Note:** Caching has moved to [`platform-caching`](../platform-caching/) and cryptography/OTP to [`platform-cryptography`](../platform-cryptography/). Re-exports are still available from `platform-core` for backward compatibility.
12
14
 
13
15
  **Package:** `@breadstone/archipel-platform-core`
14
16
 
package/data/packages/platform-cryptography/api/Class.BcryptService.md ADDED
@@ -0,0 +1,73 @@
1
+ ---
2
+ title: 'Class: BcryptService'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Class: BcryptService
8
+
9
+ Defined in: [BcryptService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/BcryptService.ts#L15)
10
+
11
+ The `BcryptService` class.
12
+ Represents the service that provides bcrypt operations.
13
+
14
+ ## Constructors
15
+
16
+ ### Constructor
17
+
18
+ ```ts
19
+ new BcryptService(): BcryptService;
20
+ ```
21
+
22
+ #### Returns
23
+
24
+ `BcryptService`
25
+
26
+ ## Methods
27
+
28
+ ### compare()
29
+
30
+ ```ts
31
+ compare(data, encrypted): Promise<boolean>;
32
+ ```
33
+
34
+ Defined in: [BcryptService.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/BcryptService.ts#L39)
35
+
36
+ Compares the given data with the encrypted data.
37
+
38
+ #### Parameters
39
+
40
+ | Parameter | Type | Description |
41
+ | ----------- | -------- | ---------------------------------- |
42
+ | `data` | `string` | The data to be compared. |
43
+ | `encrypted` | `string` | The encrypted data to be compared. |
44
+
45
+ #### Returns
46
+
47
+ `Promise`\<`boolean`\>
48
+
49
+ `true` if the data matches the encrypted hash; otherwise `false`.
50
+
51
+ ---
52
+
53
+ ### hash()
54
+
55
+ ```ts
56
+ hash(data): Promise<string>;
57
+ ```
58
+
59
+ Defined in: [BcryptService.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/BcryptService.ts#L26)
60
+
61
+ Hashes the given data using bcrypt with a generated salt.
62
+
63
+ #### Parameters
64
+
65
+ | Parameter | Type | Description |
66
+ | --------- | -------- | ---------------------- |
67
+ | `data` | `string` | The data to be hashed. |
68
+
69
+ #### Returns
70
+
71
+ `Promise`\<`string`\>
72
+
73
+ The bcrypt hash string.
package/data/packages/platform-cryptography/api/Class.CryptoService.md ADDED
@@ -0,0 +1,52 @@
1
+ ---
2
+ title: 'Class: CryptoService'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Class: CryptoService
8
+
9
+ Defined in: [CryptoService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/CryptoService.ts#L15)
10
+
11
+ The `CryptoService` class.
12
+ Represents the service that provides cryptographic operations.
13
+
14
+ ## Constructors
15
+
16
+ ### Constructor
17
+
18
+ ```ts
19
+ new CryptoService(): CryptoService;
20
+ ```
21
+
22
+ Defined in: [CryptoService.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/CryptoService.ts#L22)
23
+
24
+ Initializes a new instance of the `CryptoService` class.
25
+
26
+ #### Returns
27
+
28
+ `CryptoService`
29
+
30
+ ## Methods
31
+
32
+ ### getRandomGuid()
33
+
34
+ ```ts
35
+ getRandomGuid(prefix): string;
36
+ ```
37
+
38
+ Defined in: [CryptoService.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/CryptoService.ts#L37)
39
+
40
+ Generates a random GUID prefixed with the given string.
41
+
42
+ #### Parameters
43
+
44
+ | Parameter | Type | Description |
45
+ | --------- | -------- | -------------------------------------------- |
46
+ | `prefix` | `string` | The prefix to prepend to the generated UUID. |
47
+
48
+ #### Returns
49
+
50
+ `string`
51
+
52
+ The prefixed UUID string.
package/data/packages/{platform-core → platform-cryptography}/api/Class.OtpService.md RENAMED
@@ -6,7 +6,7 @@ editUrl: false
6
6
 
7
7
  # Class: OtpService
8
8
 
9
- Defined in: [services/OtpService.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/OtpService.ts#L42)
9
+ Defined in: [OtpService.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/OtpService.ts#L42)
10
10
 
11
11
  OTP service implementation backed by otplib v13.
12
12
 
@@ -38,7 +38,7 @@ new OtpService(): OtpService;
38
38
  generateSecret(): string;
39
39
  ```
40
40
 
41
- Defined in: [services/OtpService.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/OtpService.ts#L46)
41
+ Defined in: [OtpService.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/OtpService.ts#L46)
42
42
 
43
43
  Generates a cryptographically random secret suitable for TOTP.
44
44
 
@@ -46,6 +46,8 @@ Generates a cryptographically random secret suitable for TOTP.
46
46
 
47
47
  `string`
48
48
 
49
+ The generated secret string.
50
+
49
51
  #### Implementation of
50
52
 
51
53
  [`IOtpService`](Interface.IOtpService).[`generateSecret`](Interface.IOtpService#generatesecret)
@@ -58,7 +60,7 @@ Generates a cryptographically random secret suitable for TOTP.
58
60
  generateUri(options): string;
59
61
  ```
60
62
 
61
- Defined in: [services/OtpService.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/OtpService.ts#L51)
63
+ Defined in: [OtpService.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/OtpService.ts#L51)
62
64
 
63
65
  Generates an `otpauth://` URI for QR code enrollment.
64
66
 
@@ -72,6 +74,8 @@ Generates an `otpauth://` URI for QR code enrollment.
72
74
 
73
75
  `string`
74
76
 
77
+ The formatted `otpauth://` URI.
78
+
75
79
  #### Implementation of
76
80
 
77
81
  [`IOtpService`](Interface.IOtpService).[`generateUri`](Interface.IOtpService#generateuri)
@@ -84,7 +88,7 @@ Generates an `otpauth://` URI for QR code enrollment.
84
88
  verify(token, secret): boolean;
85
89
  ```
86
90
 
87
- Defined in: [services/OtpService.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/OtpService.ts#L56)
91
+ Defined in: [OtpService.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/OtpService.ts#L56)
88
92
 
89
93
  Verifies a TOTP token against the given secret.
90
94