@breadstone/archipel-mcp 0.0.2 → 0.0.3

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 (548) hide show
  1. package/data/packages/index.md +4 -2
  2. package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +20 -19
  3. package/data/packages/platform-analytics/api/Class.AnalyticsModule.md +3 -2
  4. package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +22 -21
  5. package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +22 -21
  6. package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +20 -19
  7. package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +22 -21
  8. package/data/packages/platform-analytics/api/Interface.IAnalyticsBreadcrumb.md +4 -3
  9. package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md +3 -2
  10. package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md +4 -3
  11. package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md +2 -1
  12. package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md +3 -2
  13. package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md +2 -1
  14. package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md +3 -2
  15. package/data/packages/platform-analytics/api/Variable.DD_ENV.md +2 -1
  16. package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md +2 -1
  17. package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md +3 -2
  18. package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md +2 -1
  19. package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md +2 -1
  20. package/data/packages/platform-analytics/api/index.md +26 -25
  21. package/data/packages/platform-analytics/index.md +170 -0
  22. package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +5 -4
  23. package/data/packages/platform-authentication/api/Class.AppleStrategy.md +16 -15
  24. package/data/packages/platform-authentication/api/Class.AuthModule.md +6 -5
  25. package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +11 -10
  26. package/data/packages/platform-authentication/api/Class.AuthTokenService.md +6 -5
  27. package/data/packages/platform-authentication/api/Class.ChallengeService.md +27 -26
  28. package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +5 -4
  29. package/data/packages/platform-authentication/api/Class.GithubStrategy.md +17 -16
  30. package/data/packages/platform-authentication/api/Class.GoogleStrategy.md +14 -13
  31. package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +5 -4
  32. package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +16 -15
  33. package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +11 -10
  34. package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +5 -4
  35. package/data/packages/platform-authentication/api/Class.MfaService.md +55 -54
  36. package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +9 -8
  37. package/data/packages/platform-authentication/api/Class.MicrosoftStrategy.md +14 -13
  38. package/data/packages/platform-authentication/api/Class.RolesGuard.md +6 -5
  39. package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +5 -4
  40. package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +26 -25
  41. package/data/packages/platform-authentication/api/Class.SessionResponse.md +13 -12
  42. package/data/packages/platform-authentication/api/Class.SessionService.md +34 -33
  43. package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +10 -9
  44. package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +3 -2
  45. package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +3 -2
  46. package/data/packages/platform-authentication/api/Class.VerificationService.md +30 -29
  47. package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +17 -16
  48. package/data/packages/platform-authentication/api/Function.Token.md +1 -0
  49. package/data/packages/platform-authentication/api/Function.UseRoles.md +3 -2
  50. package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md +6 -5
  51. package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +8 -7
  52. package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +8 -7
  53. package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +6 -5
  54. package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +11 -10
  55. package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +1 -0
  56. package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +4 -3
  57. package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +10 -9
  58. package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +8 -7
  59. package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +15 -14
  60. package/data/packages/platform-authentication/api/Interface.ISignInResult.md +6 -5
  61. package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +4 -3
  62. package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +6 -5
  63. package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +5 -4
  64. package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +3 -2
  65. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +2 -1
  66. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +2 -1
  67. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +2 -1
  68. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +2 -1
  69. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +2 -1
  70. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +15 -0
  71. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +2 -1
  72. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +2 -1
  73. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +2 -1
  74. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +2 -1
  75. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +2 -1
  76. package/data/packages/platform-authentication/api/Variable.AUTH_JWT_EXPIRES_IN.md +2 -1
  77. package/data/packages/platform-authentication/api/Variable.AUTH_JWT_SECRET.md +2 -1
  78. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN.md +2 -1
  79. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +2 -1
  80. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +2 -1
  81. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ENCRYPTION_KEY.md +2 -1
  82. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_MAX_ATTEMPTS.md +2 -1
  83. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +2 -1
  84. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +2 -1
  85. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +2 -1
  86. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +2 -1
  87. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +2 -1
  88. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +2 -1
  89. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +2 -1
  90. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +2 -1
  91. package/data/packages/platform-authentication/api/Variable.AUTH_VERIFY_JWT_EXPIRES_IN.md +2 -1
  92. package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +3 -2
  93. package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +3 -2
  94. package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +3 -2
  95. package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +4 -3
  96. package/data/packages/platform-authentication/api/Variable.ROLES_KEY.md +3 -2
  97. package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +3 -2
  98. package/data/packages/platform-authentication/api/Variable.SESSION_LIST_MAPPING_KEY.md +2 -1
  99. package/data/packages/platform-authentication/api/Variable.SESSION_MAPPING_KEY.md +2 -1
  100. package/data/packages/platform-authentication/api/Variable.User.md +3 -2
  101. package/data/packages/platform-authentication/api/index.md +88 -86
  102. package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +24 -23
  103. package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +19 -18
  104. package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +6 -5
  105. package/data/packages/platform-blob-storage/api/Class.BlobModule.md +5 -4
  106. package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +13 -12
  107. package/data/packages/platform-blob-storage/api/Class.BlobService.md +46 -45
  108. package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +8 -7
  109. package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +19 -18
  110. package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +6 -5
  111. package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +6 -5
  112. package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +3 -2
  113. package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +6 -5
  114. package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +3 -2
  115. package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +4 -3
  116. package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +7 -6
  117. package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +9 -8
  118. package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +13 -12
  119. package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +15 -14
  120. package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +4 -3
  121. package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +9 -8
  122. package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +2 -1
  123. package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +6 -5
  124. package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +6 -5
  125. package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +6 -5
  126. package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +2 -1
  127. package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +1 -0
  128. package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +3 -2
  129. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +2 -1
  130. package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +2 -1
  131. package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +2 -1
  132. package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +10 -9
  133. package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +11 -10
  134. package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +2 -1
  135. package/data/packages/platform-blob-storage/api/index.md +42 -41
  136. package/data/packages/platform-blob-storage/index.md +77 -22
  137. package/data/packages/platform-core/api/Class.AppHealthIndicator.md +3 -2
  138. package/data/packages/platform-core/api/Class.BcryptService.md +8 -7
  139. package/data/packages/platform-core/api/Class.BlobResourceStrategy.md +21 -20
  140. package/data/packages/platform-core/api/Class.BooleanUtils.md +13 -12
  141. package/data/packages/platform-core/api/Class.CUIDGenerator.md +18 -17
  142. package/data/packages/platform-core/api/Class.CasingInterceptor.md +11 -10
  143. package/data/packages/platform-core/api/Class.CatchUtils.md +16 -15
  144. package/data/packages/platform-core/api/Class.ConfigModule.md +8 -7
  145. package/data/packages/platform-core/api/Class.ConfigRegistry.md +9 -8
  146. package/data/packages/platform-core/api/Class.ConfigService.md +27 -26
  147. package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +18 -17
  148. package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +5 -4
  149. package/data/packages/platform-core/api/Class.CryptoService.md +4 -3
  150. package/data/packages/platform-core/api/Class.DateTimeUtils.md +13 -12
  151. package/data/packages/platform-core/api/Class.DeviceParserService.md +3 -2
  152. package/data/packages/platform-core/api/Class.EmbeddedResourceStrategy.md +23 -22
  153. package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +18 -17
  154. package/data/packages/platform-core/api/Class.ErrorTemplateService.md +16 -15
  155. package/data/packages/platform-core/api/Class.EventHub.md +26 -25
  156. package/data/packages/platform-core/api/Class.EventModule.md +1 -0
  157. package/data/packages/platform-core/api/Class.FileConfigStrategy.md +20 -19
  158. package/data/packages/platform-core/api/Class.FileResourceStrategy.md +20 -19
  159. package/data/packages/platform-core/api/Class.GUIDGenerator.md +8 -7
  160. package/data/packages/platform-core/api/Class.GlobalExceptionFilter.md +8 -7
  161. package/data/packages/platform-core/api/Class.HealthModule.md +3 -2
  162. package/data/packages/platform-core/api/Class.HealthOrchestrator.md +4 -3
  163. package/data/packages/platform-core/api/Class.HostModule.md +2 -0
  164. package/data/packages/platform-core/api/Class.HostService.md +14 -13
  165. package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md +9 -8
  166. package/data/packages/platform-core/api/Class.IdGeneratorBase.md +8 -7
  167. package/data/packages/platform-core/api/Class.IdentifierModule.md +4 -3
  168. package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistrarBase.md +5 -4
  169. package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistry.md +11 -10
  170. package/data/packages/platform-core/api/Class.IntelligenceModule.md +1 -0
  171. package/data/packages/platform-core/api/Class.IntelligenceTextGenerator.md +7 -6
  172. package/data/packages/platform-core/api/Class.LimitRequestSizeMiddleware.md +9 -8
  173. package/data/packages/platform-core/api/Class.LocalizedTextRequest.md +2 -1
  174. package/data/packages/platform-core/api/Class.LocalizedTextResponse.md +2 -1
  175. package/data/packages/platform-core/api/Class.MappingBuilder.md +19 -18
  176. package/data/packages/platform-core/api/Class.MappingModule.md +3 -2
  177. package/data/packages/platform-core/api/Class.MappingNotRegisteredError.md +6 -5
  178. package/data/packages/platform-core/api/Class.MappingProfileBase.md +3 -2
  179. package/data/packages/platform-core/api/Class.MappingService.md +53 -52
  180. package/data/packages/platform-core/api/Class.MemoryLayeredCache.md +38 -37
  181. package/data/packages/platform-core/api/Class.NoopCacheMetricsRecorder.md +20 -19
  182. package/data/packages/platform-core/api/Class.NormalizedUtils.md +21 -20
  183. package/data/packages/platform-core/api/Class.OtpService.md +9 -8
  184. package/data/packages/platform-core/api/Class.PageableRequest.md +2 -1
  185. package/data/packages/platform-core/api/Class.PageableResponse.md +4 -3
  186. package/data/packages/platform-core/api/Class.ProblemDetailException.md +7 -6
  187. package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +12 -11
  188. package/data/packages/platform-core/api/Class.QuantityResponse.md +2 -1
  189. package/data/packages/platform-core/api/Class.RedisLayeredCache.md +40 -39
  190. package/data/packages/platform-core/api/Class.ResourceManager.md +89 -88
  191. package/data/packages/platform-core/api/Class.ResourceModule.md +4 -3
  192. package/data/packages/platform-core/api/Class.ResponseReturn.md +104 -102
  193. package/data/packages/platform-core/api/Class.SseHub.md +24 -23
  194. package/data/packages/platform-core/api/Class.SseModule.md +4 -3
  195. package/data/packages/platform-core/api/Class.TimeStampResponse.md +2 -1
  196. package/data/packages/platform-core/api/Class.TypeMappingNotRegisteredError.md +6 -5
  197. package/data/packages/platform-core/api/Class.UUIDGenerator.md +8 -7
  198. package/data/packages/platform-core/api/Class.UserAvatarGeneratorService.md +5 -4
  199. package/data/packages/platform-core/api/Class.UserNameGeneratorService.md +5 -4
  200. package/data/packages/platform-core/api/Function.Public.md +1 -0
  201. package/data/packages/platform-core/api/Function.createConfigKey.md +9 -7
  202. package/data/packages/platform-core/api/Function.createEventKey.md +7 -6
  203. package/data/packages/platform-core/api/Function.createMappingKey.md +7 -6
  204. package/data/packages/platform-core/api/Function.env.md +5 -4
  205. package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +3 -2
  206. package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +5 -4
  207. package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md +2 -1
  208. package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md +6 -5
  209. package/data/packages/platform-core/api/Interface.ICacheMetricsRecorder.md +20 -19
  210. package/data/packages/platform-core/api/Interface.ICacheStats.md +5 -4
  211. package/data/packages/platform-core/api/Interface.IConfigKey.md +17 -16
  212. package/data/packages/platform-core/api/Interface.IConfigModuleOptions.md +4 -3
  213. package/data/packages/platform-core/api/Interface.IConfigRegistryEntry.md +7 -6
  214. package/data/packages/platform-core/api/Interface.IDeviceInfo.md +7 -6
  215. package/data/packages/platform-core/api/Interface.IErrorPageParams.md +11 -10
  216. package/data/packages/platform-core/api/Interface.IEventKey.md +8 -7
  217. package/data/packages/platform-core/api/Interface.IEventMap.md +1 -0
  218. package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md +6 -5
  219. package/data/packages/platform-core/api/Interface.IHealthCheckResult.md +4 -3
  220. package/data/packages/platform-core/api/Interface.IHealthIndicator.md +4 -3
  221. package/data/packages/platform-core/api/Interface.IHostContentParams.md +9 -8
  222. package/data/packages/platform-core/api/Interface.IIdGenerator.md +8 -7
  223. package/data/packages/platform-core/api/Interface.IIntelligenceArtifact.md +2 -1
  224. package/data/packages/platform-core/api/Interface.IIntelligenceCapability.md +7 -6
  225. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityMetadata.md +5 -4
  226. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityPayload.md +3 -2
  227. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityRegistry.md +11 -10
  228. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityResult.md +3 -2
  229. package/data/packages/platform-core/api/Interface.IIntelligenceCompletionUsage.md +3 -2
  230. package/data/packages/platform-core/api/Interface.IIntelligenceContext.md +6 -5
  231. package/data/packages/platform-core/api/Interface.IIntelligenceContextBuilder.md +4 -3
  232. package/data/packages/platform-core/api/Interface.IIntelligenceConversationMessageSnapshot.md +5 -4
  233. package/data/packages/platform-core/api/Interface.IIntelligenceConversationSnapshot.md +4 -3
  234. package/data/packages/platform-core/api/Interface.IIntelligenceFollowUpQuestion.md +3 -2
  235. package/data/packages/platform-core/api/Interface.IIntelligenceIntent.md +3 -2
  236. package/data/packages/platform-core/api/Interface.IIntelligenceIntentEntity.md +2 -1
  237. package/data/packages/platform-core/api/Interface.IIntelligenceMessageModel.md +5 -4
  238. package/data/packages/platform-core/api/Interface.IIntelligenceMessagePayload.md +2 -1
  239. package/data/packages/platform-core/api/Interface.IIntelligencePrompt.md +2 -1
  240. package/data/packages/platform-core/api/Interface.IIntelligencePromptMessage.md +2 -1
  241. package/data/packages/platform-core/api/Interface.IIntelligenceProviderConfiguration.md +7 -6
  242. package/data/packages/platform-core/api/Interface.IIntelligenceResponseMessage.md +2 -1
  243. package/data/packages/platform-core/api/Interface.IIntelligenceTextCompletion.md +5 -4
  244. package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerationOptions.md +3 -2
  245. package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerator.md +5 -4
  246. package/data/packages/platform-core/api/Interface.ILayeredCache.md +35 -34
  247. package/data/packages/platform-core/api/Interface.ILayeredCacheOptions.md +5 -4
  248. package/data/packages/platform-core/api/Interface.IMappingBuilder.md +18 -17
  249. package/data/packages/platform-core/api/Interface.IMappingKey.md +8 -7
  250. package/data/packages/platform-core/api/Interface.IMappingProfile.md +3 -2
  251. package/data/packages/platform-core/api/Interface.IOtpService.md +9 -8
  252. package/data/packages/platform-core/api/Interface.IOtpUriOptions.md +3 -2
  253. package/data/packages/platform-core/api/Interface.IRedisLayeredCacheOptions.md +15 -14
  254. package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +5 -4
  255. package/data/packages/platform-core/api/Interface.IResourceMetadata.md +7 -6
  256. package/data/packages/platform-core/api/Interface.IResourceResult.md +2 -1
  257. package/data/packages/platform-core/api/Interface.IResourceStrategy.md +17 -16
  258. package/data/packages/platform-core/api/Interface.ISseEventData.md +4 -3
  259. package/data/packages/platform-core/api/Interface.ISseHub.md +17 -16
  260. package/data/packages/platform-core/api/Namespace.ISseEventData.md +3 -2
  261. package/data/packages/platform-core/api/TypeAlias.CamelCase.md +3 -2
  262. package/data/packages/platform-core/api/TypeAlias.IntelligenceConversationMessageRole.md +3 -1
  263. package/data/packages/platform-core/api/TypeAlias.IntelligenceProviderName.md +2 -1
  264. package/data/packages/platform-core/api/TypeAlias.ProblemDetail.md +6 -5
  265. package/data/packages/platform-core/api/TypeAlias.ProblemDetailTypeUrlResolver.md +5 -4
  266. package/data/packages/platform-core/api/TypeAlias.SetOptional.md +5 -4
  267. package/data/packages/platform-core/api/TypeAlias.StringValue.md +2 -4
  268. package/data/packages/platform-core/api/Variable.APP_PORT.md +2 -1
  269. package/data/packages/platform-core/api/Variable.APP_URL.md +2 -1
  270. package/data/packages/platform-core/api/Variable.APP_VERSION.md +2 -1
  271. package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +2 -1
  272. package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +2 -1
  273. package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +2 -1
  274. package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +2 -1
  275. package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +2 -1
  276. package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +2 -1
  277. package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +3 -2
  278. package/data/packages/platform-core/api/Variable.IntelligenceConversationMessageRoles.md +8 -7
  279. package/data/packages/platform-core/api/Variable.IntelligenceProviderNames.md +10 -9
  280. package/data/packages/platform-core/api/Variable.IpAddress.md +7 -6
  281. package/data/packages/platform-core/api/Variable.Lang.md +6 -5
  282. package/data/packages/platform-core/api/Variable.NODE_ENV.md +2 -1
  283. package/data/packages/platform-core/api/Variable.OTP_SERVICE_TOKEN.md +2 -1
  284. package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +3 -2
  285. package/data/packages/platform-core/api/Variable.TOTP_EPOCH_TOLERANCE.md +8 -7
  286. package/data/packages/platform-core/api/Variable.UserAgent.md +3 -2
  287. package/data/packages/platform-core/api/index.md +161 -160
  288. package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +7 -6
  289. package/data/packages/platform-database/api/Class.DatabaseModule.md +6 -5
  290. package/data/packages/platform-database/api/Class.DatabaseService.md +20 -19
  291. package/data/packages/platform-database/api/Class.PrismaService.md +8 -7
  292. package/data/packages/platform-database/api/Class.RepositoryBase.md +127 -126
  293. package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +6 -5
  294. package/data/packages/platform-database/api/Function.pageable.md +10 -13
  295. package/data/packages/platform-database/api/Function.paginator.md +3 -2
  296. package/data/packages/platform-database/api/Function.query.md +8 -7
  297. package/data/packages/platform-database/api/Function.skip.md +6 -5
  298. package/data/packages/platform-database/api/Function.transactionalQuery.md +7 -6
  299. package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +1 -0
  300. package/data/packages/platform-database/api/Interface.IPaginateOptions.md +2 -1
  301. package/data/packages/platform-database/api/Interface.IPaginatedResult.md +5 -4
  302. package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +8 -7
  303. package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +6 -5
  304. package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +3 -2
  305. package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +3 -2
  306. package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +8 -7
  307. package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +4 -3
  308. package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +4 -3
  309. package/data/packages/platform-database/api/index.md +28 -27
  310. package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +33 -31
  311. package/data/packages/platform-documents/api/Class.DocumentEngine.md +8 -7
  312. package/data/packages/platform-documents/api/Class.DocumentModule.md +3 -2
  313. package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +22 -21
  314. package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +7 -5
  315. package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +6 -5
  316. package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +9 -8
  317. package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +3 -2
  318. package/data/packages/platform-documents/api/Interface.IImagePayload.md +4 -3
  319. package/data/packages/platform-documents/api/Interface.IImageProcessor.md +19 -18
  320. package/data/packages/platform-documents/api/Interface.IRenderOptions.md +4 -3
  321. package/data/packages/platform-documents/api/Interface.IRenderResult.md +4 -3
  322. package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +2 -1
  323. package/data/packages/platform-documents/api/TypeAlias.EngineType.md +2 -1
  324. package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +2 -1
  325. package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +2 -1
  326. package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +2 -1
  327. package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +2 -1
  328. package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +2 -1
  329. package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +2 -1
  330. package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +2 -1
  331. package/data/packages/platform-documents/api/index.md +29 -28
  332. package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +21 -20
  333. package/data/packages/platform-esigning/api/Class.EsigningError.md +5 -4
  334. package/data/packages/platform-esigning/api/Class.EsigningModule.md +3 -2
  335. package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +10 -9
  336. package/data/packages/platform-esigning/api/Class.EsigningService.md +25 -24
  337. package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +25 -24
  338. package/data/packages/platform-esigning/api/Class.SigningProviderError.md +10 -9
  339. package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +4 -3
  340. package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +3 -2
  341. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +7 -6
  342. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +4 -3
  343. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +4 -3
  344. package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +3 -2
  345. package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +4 -3
  346. package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +6 -5
  347. package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +6 -5
  348. package/data/packages/platform-esigning/api/Interface.ISigner.md +6 -5
  349. package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +6 -5
  350. package/data/packages/platform-esigning/api/Interface.ISigningField.md +11 -10
  351. package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +11 -10
  352. package/data/packages/platform-esigning/api/Interface.ISigningSession.md +5 -4
  353. package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +2 -1
  354. package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +2 -1
  355. package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +2 -1
  356. package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +2 -1
  357. package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +2 -1
  358. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +2 -1
  359. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +2 -1
  360. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +3 -2
  361. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +2 -1
  362. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +2 -1
  363. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +2 -1
  364. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +2 -1
  365. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +3 -2
  366. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +2 -1
  367. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +2 -1
  368. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +2 -1
  369. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +2 -1
  370. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +2 -1
  371. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +3 -2
  372. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +2 -1
  373. package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +2 -1
  374. package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +2 -1
  375. package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +2 -1
  376. package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +2 -1
  377. package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +2 -1
  378. package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +3 -2
  379. package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +2 -1
  380. package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +2 -1
  381. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +2 -1
  382. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +2 -1
  383. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +3 -2
  384. package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +2 -1
  385. package/data/packages/platform-esigning/api/Variable.SignerRoles.md +13 -12
  386. package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +15 -14
  387. package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +21 -20
  388. package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +19 -18
  389. package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +21 -20
  390. package/data/packages/platform-esigning/api/index.md +66 -65
  391. package/data/packages/platform-logging/api/Class.LoggerModule.md +1 -0
  392. package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +2 -1
  393. package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +3 -2
  394. package/data/packages/platform-logging/api/index.md +8 -7
  395. package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +3 -2
  396. package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +12 -11
  397. package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +3 -2
  398. package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +14 -13
  399. package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +5 -4
  400. package/data/packages/platform-mailing/api/Class.MailModule.md +1 -0
  401. package/data/packages/platform-mailing/api/Class.MailService.md +28 -27
  402. package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +13 -12
  403. package/data/packages/platform-mailing/api/Class.MailVerificationService.md +15 -14
  404. package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +14 -13
  405. package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +14 -13
  406. package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +14 -13
  407. package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +14 -13
  408. package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +14 -13
  409. package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +3 -2
  410. package/data/packages/platform-mailing/api/Interface.IMailEvents.md +1 -0
  411. package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +2 -1
  412. package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +2 -1
  413. package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +2 -1
  414. package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +3 -2
  415. package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +2 -1
  416. package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +2 -1
  417. package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +2 -1
  418. package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +2 -1
  419. package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +2 -1
  420. package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +2 -1
  421. package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +2 -1
  422. package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +2 -1
  423. package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +2 -1
  424. package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +2 -1
  425. package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +2 -1
  426. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +2 -1
  427. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +2 -1
  428. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +2 -1
  429. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +2 -1
  430. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +2 -1
  431. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +2 -1
  432. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +2 -1
  433. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +2 -1
  434. package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +2 -1
  435. package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +3 -2
  436. package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +2 -1
  437. package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +3 -2
  438. package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +2 -1
  439. package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +3 -2
  440. package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +2 -1
  441. package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +3 -2
  442. package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +3 -2
  443. package/data/packages/platform-mailing/api/index.md +55 -54
  444. package/data/packages/platform-mcp/api/Class.McpDiscoveryService.md +9 -8
  445. package/data/packages/platform-mcp/api/Class.McpModule.md +9 -8
  446. package/data/packages/platform-mcp/api/Class.McpRegistryService.md +17 -16
  447. package/data/packages/platform-mcp/api/Class.McpServerService.md +20 -19
  448. package/data/packages/platform-mcp/api/Function.McpPrompt.md +3 -2
  449. package/data/packages/platform-mcp/api/Function.McpResource.md +3 -2
  450. package/data/packages/platform-mcp/api/Function.McpTool.md +3 -2
  451. package/data/packages/platform-mcp/api/Interface.IMcpHandlerMetadata.md +3 -2
  452. package/data/packages/platform-mcp/api/Interface.IMcpModuleAsyncOptions.md +9 -8
  453. package/data/packages/platform-mcp/api/Interface.IMcpModuleOptions.md +4 -3
  454. package/data/packages/platform-mcp/api/Interface.IMcpModuleOptionsFactory.md +4 -3
  455. package/data/packages/platform-mcp/api/Interface.IMcpPromptMetadata.md +4 -3
  456. package/data/packages/platform-mcp/api/Interface.IMcpResourceMetadata.md +5 -4
  457. package/data/packages/platform-mcp/api/Interface.IMcpToolMetadata.md +6 -5
  458. package/data/packages/platform-mcp/api/Interface.IRegisteredPrompt.md +4 -3
  459. package/data/packages/platform-mcp/api/Interface.IRegisteredResource.md +4 -3
  460. package/data/packages/platform-mcp/api/Interface.IRegisteredTool.md +4 -3
  461. package/data/packages/platform-mcp/api/Interface.ISseTransportOptions.md +1 -0
  462. package/data/packages/platform-mcp/api/Interface.IStreamableHttpTransportOptions.md +2 -1
  463. package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +2 -1
  464. package/data/packages/platform-mcp/api/index.md +27 -26
  465. package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +6 -5
  466. package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +6 -5
  467. package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +17 -16
  468. package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +3 -2
  469. package/data/packages/platform-openapi/api/Function.Api.md +14 -13
  470. package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +5 -4
  471. package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +1 -0
  472. package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +7 -8
  473. package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +6 -5
  474. package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +6 -5
  475. package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +2 -1
  476. package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +3 -2
  477. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +2 -1
  478. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +2 -1
  479. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +2 -1
  480. package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +3 -2
  481. package/data/packages/platform-openapi/api/index.md +25 -24
  482. package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +8 -7
  483. package/data/packages/platform-payments/api/Class.FeatureGuard.md +7 -6
  484. package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +8 -7
  485. package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +25 -24
  486. package/data/packages/platform-payments/api/Class.MollieClient.md +25 -24
  487. package/data/packages/platform-payments/api/Class.PaddleClient.md +25 -24
  488. package/data/packages/platform-payments/api/Class.PaymentClientPort.md +26 -25
  489. package/data/packages/platform-payments/api/Class.PaymentModule.md +3 -2
  490. package/data/packages/platform-payments/api/Class.StripeClient.md +25 -24
  491. package/data/packages/platform-payments/api/Function.RequiresFeature.md +3 -2
  492. package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +5 -4
  493. package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +6 -5
  494. package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +7 -6
  495. package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +9 -8
  496. package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +3 -2
  497. package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +4 -3
  498. package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +10 -9
  499. package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +3 -2
  500. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +2 -1
  501. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +3 -2
  502. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +2 -1
  503. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +2 -1
  504. package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +2 -1
  505. package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +3 -2
  506. package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +2 -1
  507. package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +2 -1
  508. package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +3 -2
  509. package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +2 -1
  510. package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +2 -1
  511. package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +2 -1
  512. package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +3 -2
  513. package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +2 -1
  514. package/data/packages/platform-payments/api/index.md +41 -40
  515. package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +4 -3
  516. package/data/packages/platform-reporting/api/Class.ReportingDatasetNotFoundError.md +4 -3
  517. package/data/packages/platform-reporting/api/Class.ReportingFacade.md +9 -8
  518. package/data/packages/platform-reporting/api/Class.ReportingModule.md +1 -0
  519. package/data/packages/platform-reporting/api/Interface.IReportingContributor.md +5 -4
  520. package/data/packages/platform-reporting/api/Interface.IReportingDataset.md +6 -5
  521. package/data/packages/platform-reporting/api/Interface.IReportingDatasetField.md +5 -4
  522. package/data/packages/platform-reporting/api/Interface.IReportingQuery.md +5 -4
  523. package/data/packages/platform-reporting/api/Interface.IReportingQueryFilter.md +3 -2
  524. package/data/packages/platform-reporting/api/Interface.IReportingQueryResult.md +5 -4
  525. package/data/packages/platform-reporting/api/Interface.IReportingQuerySort.md +2 -1
  526. package/data/packages/platform-reporting/api/TypeAlias.ReportingFieldType.md +2 -1
  527. package/data/packages/platform-reporting/api/TypeAlias.ReportingFilterOperator.md +2 -1
  528. package/data/packages/platform-reporting/api/TypeAlias.ReportingQueryResultRow.md +1 -0
  529. package/data/packages/platform-reporting/api/Variable.ReportingFieldTypes.md +13 -12
  530. package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +11 -10
  531. package/data/packages/platform-reporting/api/index.md +24 -23
  532. package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +23 -22
  533. package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +27 -26
  534. package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +24 -23
  535. package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +36 -35
  536. package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +3 -2
  537. package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +5 -4
  538. package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +23 -22
  539. package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +3 -2
  540. package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +9 -8
  541. package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +3 -2
  542. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +2 -1
  543. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +2 -1
  544. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +2 -1
  545. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md +2 -1
  546. package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +1 -0
  547. package/data/packages/platform-telemetry/api/index.md +21 -20
  548. package/package.json +1 -1
@@ -3,183 +3,184 @@ title: '@breadstone/archipel-platform-core'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # @breadstone/archipel-platform-core
7
8
 
8
9
  ## Namespaces
9
10
 
10
- | Namespace | Description |
11
- | ------ | ------ |
11
+ | Namespace | Description |
12
+ | ---------------------------------------- | ------------------------------------------- |
12
13
  | [ISseEventData](Namespace.ISseEventData) | Represents the data of a Server-Sent Event. |
13
14
 
14
15
  ## Classes
15
16
 
16
- | Class | Description |
17
- | ------ | ------ |
18
- | [AppHealthIndicator](Class.AppHealthIndicator) | Health indicator for the application. |
19
- | [BcryptService](Class.BcryptService) | The `BcryptService` class. Represents the service that provides bcrypt operations. |
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
- | [CryptoService](Class.CryptoService) | The `CryptoService` class. Represents the service that provides cryptographic operations. |
30
- | [CUIDGenerator](Class.CUIDGenerator) | CUID Generator class |
31
- | [DateTimeUtils](Class.DateTimeUtils) | TimeSpan Utility Class. Provides methods to parse and format time span values. |
32
- | [DeviceParserService](Class.DeviceParserService) | The `DeviceParserService` class. |
33
- | [EmbeddedResourceStrategy](Class.EmbeddedResourceStrategy) | Strategy for loading embedded resources from memory. |
34
- | [EnvironmentConfigStrategy](Class.EnvironmentConfigStrategy) | The `EnvironmentConfigStrategy` class. |
35
- | [ErrorTemplateService](Class.ErrorTemplateService) | Service for rendering error page templates. |
36
- | [EventHub](Class.EventHub) | Provides a strongly typed event hub that can publish and subscribe to events. |
37
- | [EventModule](Class.EventModule) | Module that provides event hub services. |
38
- | [FileConfigStrategy](Class.FileConfigStrategy) | The `FileConfigStrategy` class. |
39
- | [FileResourceStrategy](Class.FileResourceStrategy) | Strategy for loading resources from the local file system. |
40
- | [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. |
41
- | [GUIDGenerator](Class.GUIDGenerator) | GUID Generator class |
42
- | [HealthModule](Class.HealthModule) | - |
43
- | [HealthOrchestrator](Class.HealthOrchestrator) | Orchestrates execution of all registered health indicators and aggregates their results. |
44
- | [HostModule](Class.HostModule) | The `HostModule` provides host-related services globally. |
45
- | [HostService](Class.HostService) | The `HostService` class. |
46
- | [HttpLoggerMiddleware](Class.HttpLoggerMiddleware) | - |
47
- | [IdentifierModule](Class.IdentifierModule) | - |
48
- | [IdGeneratorBase](Class.IdGeneratorBase) | Abstract base class for ID Generators |
49
- | [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. |
50
- | [IntelligenceCapabilityRegistry](Class.IntelligenceCapabilityRegistry) | Central registry responsible for resolving intelligence capabilities based on intent metadata. |
51
- | [IntelligenceModule](Class.IntelligenceModule) | Core module exposing the shared intelligence infrastructure to feature modules. |
52
- | [IntelligenceTextGenerator](Class.IntelligenceTextGenerator) | Executes text completions using the configured intelligence provider. |
53
- | [LimitRequestSizeMiddleware](Class.LimitRequestSizeMiddleware) | - |
54
- | [LocalizedTextRequest](Class.LocalizedTextRequest) | Request DTO for a single localized text entry. |
55
- | [LocalizedTextResponse](Class.LocalizedTextResponse) | Base class for localized text responses. |
56
- | [MappingBuilder](Class.MappingBuilder) | A mapping builder that uses the mapping service to register maps. |
57
- | [MappingModule](Class.MappingModule) | Module that provides mapping services and allows registration of mapping profiles. |
58
- | [MappingNotRegisteredError](Class.MappingNotRegisteredError) | Thrown when a keyed mapping is requested but not registered. |
59
- | [MappingProfileBase](Class.MappingProfileBase) | Base class for mapping profiles to simplify implementation. |
60
- | [MappingService](Class.MappingService) | Central mapping registry supporting keyed & type-based mappings. |
61
- | [MemoryLayeredCache](Class.MemoryLayeredCache) | In-memory layered cache implementation. |
62
- | [NoopCacheMetricsRecorder](Class.NoopCacheMetricsRecorder) | No-op implementation used when no metrics backend is configured. |
63
- | [NormalizedUtils](Class.NormalizedUtils) | Utility functions for normalizing data. |
64
- | [OtpService](Class.OtpService) | OTP service implementation backed by otplib v13. |
65
- | [PageableRequest](Class.PageableRequest) | Base class describing pagination query parameters shared across endpoints. |
66
- | [PageableResponse](Class.PageableResponse) | Base class describing pagination metadata returned alongside list payloads. |
67
- | [ProblemDetailException](Class.ProblemDetailException) | A NestJS HttpException that represents a Problem Detail as per RFC 7807. |
68
- | [ProblemDetailExceptionFilter](Class.ProblemDetailExceptionFilter) | A NestJS exception filter that transforms exceptions into Problem Details compliant responses as per RFC 7807. |
69
- | [QuantityResponse](Class.QuantityResponse) | Base class for quantity responses. |
70
- | [RedisLayeredCache](Class.RedisLayeredCache) | Generic layered cache contract (DB first, then memory, then external fetcher). |
71
- | [ResourceManager](Class.ResourceManager) | Central manager for loading resources from various sources. Supports multiple strategies (file, blob, embedded) with caching. |
72
- | [ResourceModule](Class.ResourceModule) | Module providing the ResourceManager. |
73
- | [ResponseReturn](Class.ResponseReturn) | - |
74
- | [SseHub](Class.SseHub) | Represents a server-sent event service. |
75
- | [SseModule](Class.SseModule) | Represents the `SseModule` class. |
76
- | [TimeStampResponse](Class.TimeStampResponse) | The base class for all time stamp responses. |
77
- | [TypeMappingNotRegisteredError](Class.TypeMappingNotRegisteredError) | Thrown when a type mapping is requested but not registered. |
78
- | [UserAvatarGeneratorService](Class.UserAvatarGeneratorService) | Service for generating GitHub-style identicon avatars. |
79
- | [UserNameGeneratorService](Class.UserNameGeneratorService) | Random user name generator class |
80
- | [UUIDGenerator](Class.UUIDGenerator) | UUID Generator class |
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 |
81
82
 
82
83
  ## Interfaces
83
84
 
84
- | Interface | Description |
85
- | ------ | ------ |
86
- | [IBlobResourceStrategyConfig](Interface.IBlobResourceStrategyConfig) | Configuration for the blob resource strategy. |
87
- | [IBlobServiceAdapter](Interface.IBlobServiceAdapter) | Minimal blob service interface to avoid circular dependencies. |
88
- | [ICacheMetricsRecorder](Interface.ICacheMetricsRecorder) | Metrics recorder for cache operations. Implementations can forward to Prometheus, OpenTelemetry, etc. |
89
- | [ICacheStats](Interface.ICacheStats) | Cache statistics. |
90
- | [IConfigKey](Interface.IConfigKey) | A type-safe config key that encodes both the config key and the type of its value. |
91
- | [IConfigModuleOptions](Interface.IConfigModuleOptions) | The `IConfigModuleOptions` interface. |
92
- | [IConfigRegistryEntry](Interface.IConfigRegistryEntry) | Describes a registered configuration entry, including its source module and whether the entry is required or optional (with a default value). |
93
- | [IDeviceInfo](Interface.IDeviceInfo) | Interface for parsed device information |
94
- | [IErrorPageParams](Interface.IErrorPageParams) | Parameters for generating error page content. |
95
- | [IEventKey](Interface.IEventKey) | Represents a strongly typed event key that encodes the payload type. |
96
- | [IEventMap](Interface.IEventMap) | Represents the shape of the event map used by the [EventHub](Class.EventHub). |
97
- | [IFileResourceStrategyConfig](Interface.IFileResourceStrategyConfig) | Configuration for the file resource strategy. |
98
- | [IHealthCheckResult](Interface.IHealthCheckResult) | Represents the result of a health check indicator. |
99
- | [IHealthIndicator](Interface.IHealthIndicator) | Defines the contract for a health indicator that can be orchestrated. |
100
- | [IHostContentParams](Interface.IHostContentParams) | Parameters for generating host content. |
101
- | [IIdGenerator](Interface.IIdGenerator) | Interface for ID generators |
102
- | [IIntelligenceArtifact](Interface.IIntelligenceArtifact) | Represents a structured artifact returned by a capability. |
103
- | [IIntelligenceCapability](Interface.IIntelligenceCapability) | Abstraction implemented by all capability providers. |
104
- | [IIntelligenceCapabilityMetadata](Interface.IIntelligenceCapabilityMetadata) | Metadata describing a capability for orchestration and analytics purposes. |
105
- | [IIntelligenceCapabilityPayload](Interface.IIntelligenceCapabilityPayload) | Payload forwarded to capabilities for execution. |
106
- | [IIntelligenceCapabilityRegistry](Interface.IIntelligenceCapabilityRegistry) | Registry abstraction responsible for resolving capabilities. |
107
- | [IIntelligenceCapabilityResult](Interface.IIntelligenceCapabilityResult) | Represents the outcome produced by a capability execution. |
108
- | [IIntelligenceCompletionUsage](Interface.IIntelligenceCompletionUsage) | Captures usage telemetry returned by the intelligence provider. |
109
- | [IIntelligenceContext](Interface.IIntelligenceContext) | Describes the context aggregated before routing a request to a capability. |
110
- | [IIntelligenceContextBuilder](Interface.IIntelligenceContextBuilder) | Responsible for composing the context supplied to capabilities. |
111
- | [IIntelligenceConversationMessageSnapshot](Interface.IIntelligenceConversationMessageSnapshot) | Represents a single message returned within a conversation snapshot. |
112
- | [IIntelligenceConversationSnapshot](Interface.IIntelligenceConversationSnapshot) | Represents a lightweight snapshot of a conversation used for context building. |
113
- | [IIntelligenceFollowUpQuestion](Interface.IIntelligenceFollowUpQuestion) | Represents a follow-up question suggested to keep the dialogue active. |
114
- | [IIntelligenceIntent](Interface.IIntelligenceIntent) | Represents the structured intent resolved from a user message. |
115
- | [IIntelligenceIntentEntity](Interface.IIntelligenceIntentEntity) | Represents an entity extracted from a resolved intelligence intent. |
116
- | [IIntelligenceMessageModel](Interface.IIntelligenceMessageModel) | Represents a normalized message stored in persistence. |
117
- | [IIntelligenceMessagePayload](Interface.IIntelligenceMessagePayload) | Carries the payload submitted when messaging the intelligence entrypoint. |
118
- | [IIntelligencePrompt](Interface.IIntelligencePrompt) | Represents the input supplied to the intelligence text generator. |
119
- | [IIntelligencePromptMessage](Interface.IIntelligencePromptMessage) | Describes a normalized message used for text generation prompts. |
120
- | [IIntelligenceProviderConfiguration](Interface.IIntelligenceProviderConfiguration) | Describes the resolved configuration for the intelligence provider. |
121
- | [IIntelligenceResponseMessage](Interface.IIntelligenceResponseMessage) | Represents a single assistant message returned by a capability. |
122
- | [IIntelligenceTextCompletion](Interface.IIntelligenceTextCompletion) | Represents the normalized completion result produced by the intelligence provider. |
123
- | [IIntelligenceTextGenerationOptions](Interface.IIntelligenceTextGenerationOptions) | Options that can be supplied when generating text with the intelligence provider. |
124
- | [IIntelligenceTextGenerator](Interface.IIntelligenceTextGenerator) | Abstraction responsible for executing text completions using the configured provider. |
125
- | [ILayeredCache](Interface.ILayeredCache) | Generic layered cache contract (DB first, then memory, then external fetcher). |
126
- | [ILayeredCacheOptions](Interface.ILayeredCacheOptions) | In-memory layered cache: memory (LRU+TTL+SWR) + async loader fallback. |
127
- | [IMappingBuilder](Interface.IMappingBuilder) | Defines the interface for a mapping builder. |
128
- | [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. |
129
- | [IMappingProfile](Interface.IMappingProfile) | Defines the interface for a mapping profile. |
130
- | [IOtpService](Interface.IOtpService) | Abstraction over OTP (One-Time Password) operations. |
131
- | [IOtpUriOptions](Interface.IOtpUriOptions) | Options for generating an OTP authentication URI (otpauth://). |
132
- | [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. |
133
- | [IResourceManagerConfig](Interface.IResourceManagerConfig) | Configuration for the ResourceManager. |
134
- | [IResourceMetadata](Interface.IResourceMetadata) | Metadata about a resource. |
135
- | [IResourceResult](Interface.IResourceResult) | Result of loading a resource. |
136
- | [IResourceStrategy](Interface.IResourceStrategy) | Strategy for loading resources from a specific source. |
137
- | [ISseEventData](Interface.ISseEventData) | Represents the data of a Server-Sent Event. |
138
- | [ISseHub](Interface.ISseHub) | Represents a server-sent event service. |
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. |
139
140
 
140
141
  ## Type Aliases
141
142
 
142
- | Type Alias | Description |
143
- | ------ | ------ |
144
- | [CamelCase](TypeAlias.CamelCase) | - |
145
- | [IntelligenceConversationMessageRole](TypeAlias.IntelligenceConversationMessageRole) | Represents the union of supported conversation message roles. |
146
- | [IntelligenceProviderName](TypeAlias.IntelligenceProviderName) | Represents the union of supported intelligence provider identifiers. |
147
- | [ProblemDetail](TypeAlias.ProblemDetail) | A Problem Detail object as per RFC 7807. |
148
- | [ProblemDetailTypeUrlResolver](TypeAlias.ProblemDetailTypeUrlResolver) | A function that resolves a type URL for a given HTTP status code and title. |
149
- | [SetOptional](TypeAlias.SetOptional) | Sets the specified keys of T as optional. |
150
- | [StringValue](TypeAlias.StringValue) | - |
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) | - |
151
152
 
152
153
  ## Variables
153
154
 
154
- | Variable | Description |
155
- | ------ | ------ |
156
- | [APP\_PORT](Variable.APP_PORT) | HTTP port the application listens on. |
157
- | [APP\_URL](Variable.APP_URL) | Base URL the application is served from (e.g. `https://example.com`). |
158
- | [APP\_VERSION](Variable.APP_VERSION) | Semantic version of the running application (e.g. `1.2.3`). |
159
- | [HEALTH\_INDICATORS\_TOKEN](Variable.HEALTH_INDICATORS_TOKEN) | Injection token for registered health indicators |
160
- | [ID\_GENERATOR\_TOKEN](Variable.ID_GENERATOR_TOKEN) | Interface for ID generators |
161
- | [INTELLIGENCE\_MAX\_OUTPUT\_TOKENS](Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS) | Maximum number of output tokens for the AI model. |
162
- | [INTELLIGENCE\_MODEL](Variable.INTELLIGENCE_MODEL) | AI model identifier to use for text generation. |
163
- | [INTELLIGENCE\_TEMPERATURE](Variable.INTELLIGENCE_TEMPERATURE) | Sampling temperature for the AI model. |
164
- | [INTELLIGENCE\_TOP\_P](Variable.INTELLIGENCE_TOP_P) | Top-p (nucleus sampling) for the AI model. |
165
- | [IntelligenceConversationMessageRoles](Variable.IntelligenceConversationMessageRoles) | Enumerates the conversation roles used for contextual snapshots and messages. |
166
- | [IntelligenceProviderNames](Variable.IntelligenceProviderNames) | Enumerates the supported model providers powering the intelligence pipeline. |
167
- | [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. |
168
- | [IS\_PUBLIC\_KEY](Variable.IS_PUBLIC_KEY) | - |
169
- | [Lang](Variable.Lang) | Extracts the first language token from the Accept-Language header. |
170
- | [NODE\_ENV](Variable.NODE_ENV) | The current Node.js environment (`development`, `production`, etc.). |
171
- | [OTP\_SERVICE\_TOKEN](Variable.OTP_SERVICE_TOKEN) | Injection token for [IOtpService](Interface.IOtpService). |
172
- | [PLATFORM\_CORE\_CONFIG\_ENTRIES](Variable.PLATFORM_CORE_CONFIG_ENTRIES) | All configuration entries required by `platform-core`. |
173
- | [TOTP\_EPOCH\_TOLERANCE](Variable.TOTP_EPOCH_TOLERANCE) | TOTP verification tolerance expressed in **seconds** (otplib v13 `epochTolerance`). |
174
- | [UserAgent](Variable.UserAgent) | Extracts the User-Agent header from the incoming HTTP request. |
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. |
175
176
 
176
177
  ## Functions
177
178
 
178
- | Function | Description |
179
- | ------ | ------ |
180
- | [createConfigKey](Function.createConfigKey) | Creates a type-safe config key. |
181
- | [createEventKey](Function.createEventKey) | Creates a branded event key for the [EventHub](Class.EventHub). |
182
- | [createMappingKey](Function.createMappingKey) | Creates a type-safe mapping key. |
183
- | [env](Function.env) | Marker function for environment strings. |
184
- | [getMimeTypeByFileNameOrExtension](Function.getMimeTypeByFileNameOrExtension) | Get MIME type by file name or extension. |
185
- | [Public](Function.Public) | The `Public` decorator. |
179
+ | Function | Description |
180
+ | ----------------------------------------------------------------------------- | --------------------------------------------------------------- |
181
+ | [createConfigKey](Function.createConfigKey) | Creates a type-safe config key. |
182
+ | [createEventKey](Function.createEventKey) | Creates a branded event key for the [EventHub](Class.EventHub). |
183
+ | [createMappingKey](Function.createMappingKey) | Creates a type-safe mapping key. |
184
+ | [env](Function.env) | Marker function for environment strings. |
185
+ | [getMimeTypeByFileNameOrExtension](Function.getMimeTypeByFileNameOrExtension) | Get MIME type by file name or extension. |
186
+ | [Public](Function.Public) | The `Public` decorator. |
@@ -3,6 +3,7 @@ title: 'Class: DatabaseHealthIndicator'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Class: DatabaseHealthIndicator
7
8
 
8
9
  Defined in: [terminus/DatabaseHealthIndicator.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/terminus/DatabaseHealthIndicator.ts#L16)
@@ -25,10 +26,10 @@ Defined in: [terminus/DatabaseHealthIndicator.ts:26](https://github.com/RueDeRen
25
26
 
26
27
  #### Parameters
27
28
 
28
- | Parameter | Type |
29
- | ------ | ------ |
30
- | `prismaHealthIndicator` | `PrismaHealthIndicator` |
31
- | `databaseService` | [`DatabaseService`](Class.DatabaseService) |
29
+ | Parameter | Type |
30
+ | ----------------------- | ------------------------------------------ |
31
+ | `prismaHealthIndicator` | `PrismaHealthIndicator` |
32
+ | `databaseService` | [`DatabaseService`](Class.DatabaseService) |
32
33
 
33
34
  #### Returns
34
35
 
@@ -49,7 +50,7 @@ Unique key identifying the indicator
49
50
  #### Implementation of
50
51
 
51
52
  ```ts
52
- IHealthIndicator.key
53
+ IHealthIndicator.key;
53
54
  ```
54
55
 
55
56
  ## Methods
@@ -71,5 +72,5 @@ Performs the health check and returns a result keyed by the indicator key
71
72
  #### Implementation of
72
73
 
73
74
  ```ts
74
- IHealthIndicator.check
75
+ IHealthIndicator.check;
75
76
  ```
@@ -3,6 +3,7 @@ title: 'Class: DatabaseModule'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Class: DatabaseModule
7
8
 
8
9
  Defined in: [DatabaseModule.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L48)
@@ -35,8 +36,8 @@ Registers the `DatabaseModule` with global middlewares.
35
36
 
36
37
  #### Parameters
37
38
 
38
- | Parameter | Type | Description |
39
- | ------ | ------ | ------ |
39
+ | Parameter | Type | Description |
40
+ | --------- | ---------------------------------------------------------- | --------------------------------- |
40
41
  | `config?` | [`IDatabaseModuleConfig`](Interface.IDatabaseModuleConfig) | The database module configuration |
41
42
 
42
43
  #### Returns
@@ -45,7 +46,7 @@ Registers the `DatabaseModule` with global middlewares.
45
46
 
46
47
  A `DynamicModule` that can be imported globally
47
48
 
48
- ***
49
+ ---
49
50
 
50
51
  ### register()
51
52
 
@@ -59,8 +60,8 @@ Registers the `DatabaseModule` with dynamic middlewares.
59
60
 
60
61
  #### Parameters
61
62
 
62
- | Parameter | Type | Description |
63
- | ------ | ------ | ------ |
63
+ | Parameter | Type | Description |
64
+ | --------- | ---------------------------------------------------------- | --------------------------------- |
64
65
  | `config?` | [`IDatabaseModuleConfig`](Interface.IDatabaseModuleConfig) | The database module configuration |
65
66
 
66
67
  #### Returns
@@ -3,6 +3,7 @@ title: 'Class: DatabaseService'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Class: DatabaseService
7
8
 
8
9
  Defined in: [services/DatabaseService.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/services/DatabaseService.ts#L16)
@@ -33,8 +34,8 @@ Constructs a new instance of the `DatabaseService` class.
33
34
 
34
35
  #### Parameters
35
36
 
36
- | Parameter | Type |
37
- | ------ | ------ |
37
+ | Parameter | Type |
38
+ | --------------- | --------------- |
38
39
  | `configService` | `ConfigService` |
39
40
 
40
41
  #### Returns
@@ -63,7 +64,7 @@ Defined in: [services/PrismaService.ts:80](https://github.com/RueDeRennes/archip
63
64
 
64
65
  [`PrismaService`](Class.PrismaService).[`onModuleDestroy`](Class.PrismaService#onmoduledestroy)
65
66
 
66
- ***
67
+ ---
67
68
 
68
69
  ### onModuleInit()
69
70
 
@@ -81,7 +82,7 @@ Defined in: [services/PrismaService.ts:68](https://github.com/RueDeRennes/archip
81
82
 
82
83
  [`PrismaService`](Class.PrismaService).[`onModuleInit`](Class.PrismaService#onmoduleinit)
83
84
 
84
- ***
85
+ ---
85
86
 
86
87
  ### transaction()
87
88
 
@@ -95,16 +96,16 @@ Creates a new transaction.
95
96
 
96
97
  #### Type Parameters
97
98
 
98
- | Type Parameter |
99
- | ------ |
100
- | `P` *extends* `PrismaPromise`\<`unknown`\>[] |
99
+ | Type Parameter |
100
+ | -------------------------------------------- |
101
+ | `P` _extends_ `PrismaPromise`\<`unknown`\>[] |
101
102
 
102
103
  #### Parameters
103
104
 
104
- | Parameter | Type | Description |
105
- | ------ | ------ | ------ |
106
- | `arg` | \[`...P[]`\] | The argument. |
107
- | `options?` | `unknown` | The options. |
105
+ | Parameter | Type | Description |
106
+ | ---------- | ------------ | ------------- |
107
+ | `arg` | \[`...P[]`\] | The argument. |
108
+ | `options?` | `unknown` | The options. |
108
109
 
109
110
  #### Returns
110
111
 
@@ -112,7 +113,7 @@ Creates a new transaction.
112
113
 
113
114
  Returns the result of the transaction.
114
115
 
115
- ***
116
+ ---
116
117
 
117
118
  ### transactionCallback()
118
119
 
@@ -127,21 +128,21 @@ Executes a transactional callback (extended overload missing in base typing wrap
127
128
  #### Type Parameters
128
129
 
129
130
  | Type Parameter |
130
- | ------ |
131
- | `T` |
131
+ | -------------- |
132
+ | `T` |
132
133
 
133
134
  #### Parameters
134
135
 
135
- | Parameter | Type |
136
- | ------ | ------ |
137
- | `fn` | (`tx`) => `Promise`\<`T`\> |
138
- | `options?` | `unknown` |
136
+ | Parameter | Type |
137
+ | ---------- | -------------------------- |
138
+ | `fn` | (`tx`) => `Promise`\<`T`\> |
139
+ | `options?` | `unknown` |
139
140
 
140
141
  #### Returns
141
142
 
142
143
  `Promise`\<`T`\>
143
144
 
144
- ***
145
+ ---
145
146
 
146
147
  ### withExtensions()
147
148