@breadstone/archipel-mcp 0.0.2 → 0.0.4

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 +7 -6
  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 +11 -10
  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,6 +3,7 @@ title: 'Interface: IReportingDataset'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Interface: IReportingDataset
7
8
 
8
9
  Defined in: [models/ReportingDataset.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDataset.ts#L12)
@@ -21,7 +22,7 @@ Defined in: [models/ReportingDataset.ts:17](https://github.com/RueDeRennes/archi
21
22
 
22
23
  Fully qualified dataset identifier (`<feature>.<dataset>`).
23
24
 
24
- ***
25
+ ---
25
26
 
26
27
  ### datasetKey
27
28
 
@@ -33,7 +34,7 @@ Defined in: [models/ReportingDataset.ts:27](https://github.com/RueDeRennes/archi
33
34
 
34
35
  Dataset key within the feature namespace.
35
36
 
36
- ***
37
+ ---
37
38
 
38
39
  ### description?
39
40
 
@@ -45,7 +46,7 @@ Defined in: [models/ReportingDataset.ts:37](https://github.com/RueDeRennes/archi
45
46
 
46
47
  Optional dataset description presented to consumers.
47
48
 
48
- ***
49
+ ---
49
50
 
50
51
  ### featureKey
51
52
 
@@ -57,7 +58,7 @@ Defined in: [models/ReportingDataset.ts:22](https://github.com/RueDeRennes/archi
57
58
 
58
59
  Feature namespace owning the dataset.
59
60
 
60
- ***
61
+ ---
61
62
 
62
63
  ### fields
63
64
 
@@ -69,7 +70,7 @@ Defined in: [models/ReportingDataset.ts:42](https://github.com/RueDeRennes/archi
69
70
 
70
71
  Fields exposed by the dataset.
71
72
 
72
- ***
73
+ ---
73
74
 
74
75
  ### name
75
76
 
@@ -3,6 +3,7 @@ title: 'Interface: IReportingDatasetField'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Interface: IReportingDatasetField
7
8
 
8
9
  Defined in: [models/ReportingDatasetField.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L25)
@@ -21,7 +22,7 @@ Defined in: [models/ReportingDatasetField.ts:50](https://github.com/RueDeRennes/
21
22
 
22
23
  Optional documentation describing the semantic meaning of the field.
23
24
 
24
- ***
25
+ ---
25
26
 
26
27
  ### fieldId
27
28
 
@@ -33,7 +34,7 @@ Defined in: [models/ReportingDatasetField.ts:30](https://github.com/RueDeRennes/
33
34
 
34
35
  Unique identifier of the field within the dataset.
35
36
 
36
- ***
37
+ ---
37
38
 
38
39
  ### isNullable
39
40
 
@@ -45,7 +46,7 @@ Defined in: [models/ReportingDatasetField.ts:45](https://github.com/RueDeRennes/
45
46
 
46
47
  Indicates whether the field can contain null values.
47
48
 
48
- ***
49
+ ---
49
50
 
50
51
  ### label
51
52
 
@@ -57,7 +58,7 @@ Defined in: [models/ReportingDatasetField.ts:35](https://github.com/RueDeRennes/
57
58
 
58
59
  Human readable name of the field.
59
60
 
60
- ***
61
+ ---
61
62
 
62
63
  ### type
63
64
 
@@ -3,6 +3,7 @@ title: 'Interface: IReportingQuery'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Interface: IReportingQuery
7
8
 
8
9
  Defined in: [models/ReportingQuery.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L45)
@@ -19,7 +20,7 @@ readonly datasetId: string;
19
20
 
20
21
  Defined in: [models/ReportingQuery.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L46)
21
22
 
22
- ***
23
+ ---
23
24
 
24
25
  ### filters?
25
26
 
@@ -29,7 +30,7 @@ readonly optional filters?: readonly IReportingQueryFilter[];
29
30
 
30
31
  Defined in: [models/ReportingQuery.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L47)
31
32
 
32
- ***
33
+ ---
33
34
 
34
35
  ### limit?
35
36
 
@@ -39,7 +40,7 @@ readonly optional limit?: number;
39
40
 
40
41
  Defined in: [models/ReportingQuery.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L49)
41
42
 
42
- ***
43
+ ---
43
44
 
44
45
  ### offset?
45
46
 
@@ -49,7 +50,7 @@ readonly optional offset?: number;
49
50
 
50
51
  Defined in: [models/ReportingQuery.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L50)
51
52
 
52
- ***
53
+ ---
53
54
 
54
55
  ### sorts?
55
56
 
@@ -3,6 +3,7 @@ title: 'Interface: IReportingQueryFilter'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Interface: IReportingQueryFilter
7
8
 
8
9
  Defined in: [models/ReportingQuery.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L24)
@@ -19,7 +20,7 @@ readonly fieldId: string;
19
20
 
20
21
  Defined in: [models/ReportingQuery.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L25)
21
22
 
22
- ***
23
+ ---
23
24
 
24
25
  ### operator
25
26
 
@@ -29,7 +30,7 @@ readonly operator: ReportingFilterOperator;
29
30
 
30
31
  Defined in: [models/ReportingQuery.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L26)
31
32
 
32
- ***
33
+ ---
33
34
 
34
35
  ### value
35
36
 
@@ -3,6 +3,7 @@ title: 'Interface: IReportingQueryResult'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Interface: IReportingQueryResult
7
8
 
8
9
  Defined in: [models/ReportingQueryResult.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQueryResult.ts#L19)
@@ -19,7 +20,7 @@ readonly datasetId: string;
19
20
 
20
21
  Defined in: [models/ReportingQueryResult.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQueryResult.ts#L20)
21
22
 
22
- ***
23
+ ---
23
24
 
24
25
  ### fields
25
26
 
@@ -29,7 +30,7 @@ readonly fields: readonly IReportingDatasetField[];
29
30
 
30
31
  Defined in: [models/ReportingQueryResult.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQueryResult.ts#L21)
31
32
 
32
- ***
33
+ ---
33
34
 
34
35
  ### generatedAt
35
36
 
@@ -39,7 +40,7 @@ readonly generatedAt: Date;
39
40
 
40
41
  Defined in: [models/ReportingQueryResult.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQueryResult.ts#L24)
41
42
 
42
- ***
43
+ ---
43
44
 
44
45
  ### rows
45
46
 
@@ -49,7 +50,7 @@ readonly rows: readonly ReportingQueryResultRow[];
49
50
 
50
51
  Defined in: [models/ReportingQueryResult.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQueryResult.ts#L22)
51
52
 
52
- ***
53
+ ---
53
54
 
54
55
  ### totalCount
55
56
 
@@ -3,6 +3,7 @@ title: 'Interface: IReportingQuerySort'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Interface: IReportingQuerySort
7
8
 
8
9
  Defined in: [models/ReportingQuery.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L35)
@@ -19,7 +20,7 @@ readonly direction: "asc" | "desc";
19
20
 
20
21
  Defined in: [models/ReportingQuery.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L37)
21
22
 
22
- ***
23
+ ---
23
24
 
24
25
  ### fieldId
25
26
 
@@ -3,10 +3,11 @@ title: 'Type Alias: ReportingFieldType'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Type Alias: ReportingFieldType
7
8
 
8
9
  ```ts
9
- type ReportingFieldType = typeof ReportingFieldTypes[keyof typeof ReportingFieldTypes];
10
+ type ReportingFieldType = (typeof ReportingFieldTypes)[keyof typeof ReportingFieldTypes];
10
11
  ```
11
12
 
12
13
  Defined in: [models/ReportingDatasetField.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L18)
@@ -3,10 +3,11 @@ title: 'Type Alias: ReportingFilterOperator'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Type Alias: ReportingFilterOperator
7
8
 
8
9
  ```ts
9
- type ReportingFilterOperator = typeof ReportingFilterOperators[keyof typeof ReportingFilterOperators];
10
+ type ReportingFilterOperator = (typeof ReportingFilterOperators)[keyof typeof ReportingFilterOperators];
10
11
  ```
11
12
 
12
13
  Defined in: [models/ReportingQuery.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L17)
@@ -3,6 +3,7 @@ title: 'Type Alias: ReportingQueryResultRow'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Type Alias: ReportingQueryResultRow
7
8
 
8
9
  ```ts
@@ -3,15 +3,16 @@ title: 'Variable: ReportingFieldTypes'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Variable: ReportingFieldTypes
7
8
 
8
9
  ```ts
9
10
  const ReportingFieldTypes: {
10
- Boolean: "boolean";
11
- DateTime: "datetime";
12
- Json: "json";
13
- Number: "number";
14
- String: "string";
11
+ Boolean: 'boolean';
12
+ DateTime: 'datetime';
13
+ Json: 'json';
14
+ Number: 'number';
15
+ String: 'string';
15
16
  };
16
17
  ```
17
18
 
@@ -21,10 +22,10 @@ Enumerates the supported field data types for reporting datasets.
21
22
 
22
23
  ## Type Declaration
23
24
 
24
- | Name | Type | Default value | Defined in |
25
- | ------ | ------ | ------ | ------ |
26
- | <a id="property-boolean"></a> `Boolean` | `"boolean"` | `'boolean'` | [models/ReportingDatasetField.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L11) |
27
- | <a id="property-datetime"></a> `DateTime` | `"datetime"` | `'datetime'` | [models/ReportingDatasetField.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L12) |
28
- | <a id="property-json"></a> `Json` | `"json"` | `'json'` | [models/ReportingDatasetField.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L13) |
29
- | <a id="property-number"></a> `Number` | `"number"` | `'number'` | [models/ReportingDatasetField.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L14) |
30
- | <a id="property-string"></a> `String` | `"string"` | `'string'` | [models/ReportingDatasetField.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L15) |
25
+ | Name | Type | Default value | Defined in |
26
+ | ----------------------------------------- | ------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
27
+ | <a id="property-boolean"></a> `Boolean` | `"boolean"` | `'boolean'` | [models/ReportingDatasetField.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L11) |
28
+ | <a id="property-datetime"></a> `DateTime` | `"datetime"` | `'datetime'` | [models/ReportingDatasetField.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L12) |
29
+ | <a id="property-json"></a> `Json` | `"json"` | `'json'` | [models/ReportingDatasetField.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L13) |
30
+ | <a id="property-number"></a> `Number` | `"number"` | `'number'` | [models/ReportingDatasetField.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L14) |
31
+ | <a id="property-string"></a> `String` | `"string"` | `'string'` | [models/ReportingDatasetField.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L15) |
@@ -3,14 +3,15 @@ title: 'Variable: ReportingFilterOperators'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Variable: ReportingFilterOperators
7
8
 
8
9
  ```ts
9
10
  const ReportingFilterOperators: {
10
- Equals: "equals";
11
- GreaterThanOrEqual: "gte";
12
- In: "in";
13
- LessThanOrEqual: "lte";
11
+ Equals: 'equals';
12
+ GreaterThanOrEqual: 'gte';
13
+ In: 'in';
14
+ LessThanOrEqual: 'lte';
14
15
  };
15
16
  ```
16
17
 
@@ -20,9 +21,9 @@ Enumerates supported filter operators for dataset queries.
20
21
 
21
22
  ## Type Declaration
22
23
 
23
- | Name | Type | Default value | Defined in |
24
- | ------ | ------ | ------ | ------ |
25
- | <a id="property-equals"></a> `Equals` | `"equals"` | `'equals'` | [models/ReportingQuery.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L11) |
26
- | <a id="property-greaterthanorequal"></a> `GreaterThanOrEqual` | `"gte"` | `'gte'` | [models/ReportingQuery.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L12) |
27
- | <a id="property-in"></a> `In` | `"in"` | `'in'` | [models/ReportingQuery.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L13) |
28
- | <a id="property-lessthanorequal"></a> `LessThanOrEqual` | `"lte"` | `'lte'` | [models/ReportingQuery.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L14) |
24
+ | Name | Type | Default value | Defined in |
25
+ | ------------------------------------------------------------- | ---------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
26
+ | <a id="property-equals"></a> `Equals` | `"equals"` | `'equals'` | [models/ReportingQuery.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L11) |
27
+ | <a id="property-greaterthanorequal"></a> `GreaterThanOrEqual` | `"gte"` | `'gte'` | [models/ReportingQuery.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L12) |
28
+ | <a id="property-in"></a> `In` | `"in"` | `'in'` | [models/ReportingQuery.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L13) |
29
+ | <a id="property-lessthanorequal"></a> `LessThanOrEqual` | `"lte"` | `'lte'` | [models/ReportingQuery.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L14) |
@@ -3,40 +3,41 @@ title: '@breadstone/archipel-platform-reporting'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # @breadstone/archipel-platform-reporting
7
8
 
8
9
  ## Classes
9
10
 
10
- | Class | Description |
11
- | ------ | ------ |
12
- | [ReportingContributorRegistry](Class.ReportingContributorRegistry) | Registry responsible for tracking feature-provided reporting contributors. |
13
- | [ReportingDatasetNotFoundError](Class.ReportingDatasetNotFoundError) | Error thrown when a dataset definition could not be resolved. |
14
- | [ReportingFacade](Class.ReportingFacade) | Facade orchestrating dataset resolution and query execution for reporting consumers. |
15
- | [ReportingModule](Class.ReportingModule) | Global module providing the reporting facade and contributor registry. |
11
+ | Class | Description |
12
+ | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
13
+ | [ReportingContributorRegistry](Class.ReportingContributorRegistry) | Registry responsible for tracking feature-provided reporting contributors. |
14
+ | [ReportingDatasetNotFoundError](Class.ReportingDatasetNotFoundError) | Error thrown when a dataset definition could not be resolved. |
15
+ | [ReportingFacade](Class.ReportingFacade) | Facade orchestrating dataset resolution and query execution for reporting consumers. |
16
+ | [ReportingModule](Class.ReportingModule) | Global module providing the reporting facade and contributor registry. |
16
17
 
17
18
  ## Interfaces
18
19
 
19
- | Interface | Description |
20
- | ------ | ------ |
21
- | [IReportingContributor](Interface.IReportingContributor) | Describes a feature-level contributor that exposes reporting datasets. |
22
- | [IReportingDataset](Interface.IReportingDataset) | Represents a dataset definition that can be consumed through the reporting API. |
23
- | [IReportingDatasetField](Interface.IReportingDatasetField) | Describes a single field inside a reporting dataset. |
24
- | [IReportingQuery](Interface.IReportingQuery) | Represents an execution request for a dataset query. |
25
- | [IReportingQueryFilter](Interface.IReportingQueryFilter) | Describes a single filter applied to a dataset query execution. |
26
- | [IReportingQueryResult](Interface.IReportingQueryResult) | Represents the result of a dataset query execution. |
27
- | [IReportingQuerySort](Interface.IReportingQuerySort) | Represents a sorting instruction for a dataset query. |
20
+ | Interface | Description |
21
+ | ---------------------------------------------------------- | ------------------------------------------------------------------------------- |
22
+ | [IReportingContributor](Interface.IReportingContributor) | Describes a feature-level contributor that exposes reporting datasets. |
23
+ | [IReportingDataset](Interface.IReportingDataset) | Represents a dataset definition that can be consumed through the reporting API. |
24
+ | [IReportingDatasetField](Interface.IReportingDatasetField) | Describes a single field inside a reporting dataset. |
25
+ | [IReportingQuery](Interface.IReportingQuery) | Represents an execution request for a dataset query. |
26
+ | [IReportingQueryFilter](Interface.IReportingQueryFilter) | Describes a single filter applied to a dataset query execution. |
27
+ | [IReportingQueryResult](Interface.IReportingQueryResult) | Represents the result of a dataset query execution. |
28
+ | [IReportingQuerySort](Interface.IReportingQuerySort) | Represents a sorting instruction for a dataset query. |
28
29
 
29
30
  ## Type Aliases
30
31
 
31
- | Type Alias | Description |
32
- | ------ | ------ |
33
- | [ReportingFieldType](TypeAlias.ReportingFieldType) | - |
34
- | [ReportingFilterOperator](TypeAlias.ReportingFilterOperator) | - |
32
+ | Type Alias | Description |
33
+ | ------------------------------------------------------------ | -------------------------------------------------------- |
34
+ | [ReportingFieldType](TypeAlias.ReportingFieldType) | - |
35
+ | [ReportingFilterOperator](TypeAlias.ReportingFilterOperator) | - |
35
36
  | [ReportingQueryResultRow](TypeAlias.ReportingQueryResultRow) | Represents a single row returned by a reporting dataset. |
36
37
 
37
38
  ## Variables
38
39
 
39
- | Variable | Description |
40
- | ------ | ------ |
41
- | [ReportingFieldTypes](Variable.ReportingFieldTypes) | Enumerates the supported field data types for reporting datasets. |
42
- | [ReportingFilterOperators](Variable.ReportingFilterOperators) | Enumerates supported filter operators for dataset queries. |
40
+ | Variable | Description |
41
+ | ------------------------------------------------------------- | ----------------------------------------------------------------- |
42
+ | [ReportingFieldTypes](Variable.ReportingFieldTypes) | Enumerates the supported field data types for reporting datasets. |
43
+ | [ReportingFilterOperators](Variable.ReportingFilterOperators) | Enumerates supported filter operators for dataset queries. |
@@ -3,6 +3,7 @@ title: 'Class: NoopTelemetryFacade'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Class: NoopTelemetryFacade
7
8
 
8
9
  Defined in: [core/NoopTelemetryFacade.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/core/NoopTelemetryFacade.ts#L11)
@@ -35,12 +36,12 @@ Defined in: [core/NoopTelemetryFacade.ts:14](https://github.com/RueDeRennes/arch
35
36
 
36
37
  #### Parameters
37
38
 
38
- | Parameter | Type |
39
- | ------ | ------ |
40
- | `_` | \{ `cache`: `string`; `outcome`: `string`; `phase?`: `string`; \} |
41
- | `_.cache` | `string` |
42
- | `_.outcome` | `string` |
43
- | `_.phase?` | `string` |
39
+ | Parameter | Type |
40
+ | ----------- | ----------------------------------------------------------------- |
41
+ | `_` | \{ `cache`: `string`; `outcome`: `string`; `phase?`: `string`; \} |
42
+ | `_.cache` | `string` |
43
+ | `_.outcome` | `string` |
44
+ | `_.phase?` | `string` |
44
45
 
45
46
  #### Returns
46
47
 
@@ -50,15 +51,15 @@ Defined in: [core/NoopTelemetryFacade.ts:14](https://github.com/RueDeRennes/arch
50
51
 
51
52
  [`ITelemetryFacade`](Interface.ITelemetryFacade).[`recordCacheEvent`](Interface.ITelemetryFacade#recordcacheevent)
52
53
 
53
- ***
54
+ ---
54
55
 
55
56
  ### recordClientMetric()?
56
57
 
57
58
  ```ts
58
59
  optional recordClientMetric(
59
- name,
60
- type,
61
- value,
60
+ name,
61
+ type,
62
+ value,
62
63
  _labels?): void;
63
64
  ```
64
65
 
@@ -66,11 +67,11 @@ Defined in: [core/NoopTelemetryFacade.ts:19](https://github.com/RueDeRennes/arch
66
67
 
67
68
  #### Parameters
68
69
 
69
- | Parameter | Type |
70
- | ------ | ------ |
71
- | `name` | `string` |
72
- | `type` | `string` |
73
- | `value` | `number` |
70
+ | Parameter | Type |
71
+ | ---------- | ------------------------------ |
72
+ | `name` | `string` |
73
+ | `type` | `string` |
74
+ | `value` | `number` |
74
75
  | `_labels?` | `Record`\<`string`, `string`\> |
75
76
 
76
77
  #### Returns
@@ -81,7 +82,7 @@ Defined in: [core/NoopTelemetryFacade.ts:19](https://github.com/RueDeRennes/arch
81
82
 
82
83
  [`ITelemetryFacade`](Interface.ITelemetryFacade).[`recordClientMetric`](Interface.ITelemetryFacade#recordclientmetric)
83
84
 
84
- ***
85
+ ---
85
86
 
86
87
  ### runOperation()
87
88
 
@@ -94,15 +95,15 @@ Defined in: [core/NoopTelemetryFacade.ts:13](https://github.com/RueDeRennes/arch
94
95
  #### Type Parameters
95
96
 
96
97
  | Type Parameter |
97
- | ------ |
98
- | `T` |
98
+ | -------------- |
99
+ | `T` |
99
100
 
100
101
  #### Parameters
101
102
 
102
- | Parameter | Type |
103
- | ------ | ------ |
104
- | `_` | `string` |
105
- | `fn` | () => `T` \| `Promise`\<`T`\> |
103
+ | Parameter | Type |
104
+ | --------- | ----------------------------- |
105
+ | `_` | `string` |
106
+ | `fn` | () => `T` \| `Promise`\<`T`\> |
106
107
 
107
108
  #### Returns
108
109
 
@@ -3,6 +3,7 @@ title: 'Class: TelemetryCacheMetricsRecorder'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Class: TelemetryCacheMetricsRecorder
7
8
 
8
9
  Defined in: [core/TelemetryCacheMetricsRecorder.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/core/TelemetryCacheMetricsRecorder.ts#L15)
@@ -26,8 +27,8 @@ Defined in: [core/TelemetryCacheMetricsRecorder.ts:21](https://github.com/RueDeR
26
27
 
27
28
  #### Parameters
28
29
 
29
- | Parameter | Type |
30
- | ------ | ------ |
30
+ | Parameter | Type |
31
+ | ----------- | ------------------------------------------------ |
31
32
  | `telemetry` | [`ITelemetryFacade`](Interface.ITelemetryFacade) |
32
33
 
33
34
  #### Returns
@@ -48,9 +49,9 @@ Records a cache eviction.
48
49
 
49
50
  #### Parameters
50
51
 
51
- | Parameter | Type | Description |
52
- | ------ | ------ | ------ |
53
- | `cache` | `string` | The cache name/label |
52
+ | Parameter | Type | Description |
53
+ | --------- | -------- | -------------------- |
54
+ | `cache` | `string` | The cache name/label |
54
55
 
55
56
  #### Returns
56
57
 
@@ -59,10 +60,10 @@ Records a cache eviction.
59
60
  #### Implementation of
60
61
 
61
62
  ```ts
62
- ICacheMetricsRecorder.recordEviction
63
+ ICacheMetricsRecorder.recordEviction;
63
64
  ```
64
65
 
65
- ***
66
+ ---
66
67
 
67
68
  ### recordHit()
68
69
 
@@ -76,9 +77,9 @@ Records a cache hit.
76
77
 
77
78
  #### Parameters
78
79
 
79
- | Parameter | Type | Description |
80
- | ------ | ------ | ------ |
81
- | `cache` | `string` | The cache name/label |
80
+ | Parameter | Type | Description |
81
+ | --------- | -------- | -------------------- |
82
+ | `cache` | `string` | The cache name/label |
82
83
 
83
84
  #### Returns
84
85
 
@@ -87,10 +88,10 @@ Records a cache hit.
87
88
  #### Implementation of
88
89
 
89
90
  ```ts
90
- ICacheMetricsRecorder.recordHit
91
+ ICacheMetricsRecorder.recordHit;
91
92
  ```
92
93
 
93
- ***
94
+ ---
94
95
 
95
96
  ### recordLoadError()
96
97
 
@@ -104,9 +105,9 @@ Records a failed cache load.
104
105
 
105
106
  #### Parameters
106
107
 
107
- | Parameter | Type | Description |
108
- | ------ | ------ | ------ |
109
- | `cache` | `string` | The cache name/label |
108
+ | Parameter | Type | Description |
109
+ | --------- | -------- | -------------------- |
110
+ | `cache` | `string` | The cache name/label |
110
111
 
111
112
  #### Returns
112
113
 
@@ -115,10 +116,10 @@ Records a failed cache load.
115
116
  #### Implementation of
116
117
 
117
118
  ```ts
118
- ICacheMetricsRecorder.recordLoadError
119
+ ICacheMetricsRecorder.recordLoadError;
119
120
  ```
120
121
 
121
- ***
122
+ ---
122
123
 
123
124
  ### recordLoadSuccess()
124
125
 
@@ -132,9 +133,9 @@ Records a successful cache load.
132
133
 
133
134
  #### Parameters
134
135
 
135
- | Parameter | Type | Description |
136
- | ------ | ------ | ------ |
137
- | `cache` | `string` | The cache name/label |
136
+ | Parameter | Type | Description |
137
+ | --------- | -------- | -------------------- |
138
+ | `cache` | `string` | The cache name/label |
138
139
 
139
140
  #### Returns
140
141
 
@@ -143,10 +144,10 @@ Records a successful cache load.
143
144
  #### Implementation of
144
145
 
145
146
  ```ts
146
- ICacheMetricsRecorder.recordLoadSuccess
147
+ ICacheMetricsRecorder.recordLoadSuccess;
147
148
  ```
148
149
 
149
- ***
150
+ ---
150
151
 
151
152
  ### recordMiss()
152
153
 
@@ -160,9 +161,9 @@ Records a cache miss.
160
161
 
161
162
  #### Parameters
162
163
 
163
- | Parameter | Type | Description |
164
- | ------ | ------ | ------ |
165
- | `cache` | `string` | The cache name/label |
164
+ | Parameter | Type | Description |
165
+ | --------- | -------- | -------------------- |
166
+ | `cache` | `string` | The cache name/label |
166
167
 
167
168
  #### Returns
168
169
 
@@ -171,5 +172,5 @@ Records a cache miss.
171
172
  #### Implementation of
172
173
 
173
174
  ```ts
174
- ICacheMetricsRecorder.recordMiss
175
+ ICacheMetricsRecorder.recordMiss;
175
176
  ```