@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,6 +3,7 @@ title: 'Interface: INormalizedSubscription'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Interface: INormalizedSubscription
7
8
 
8
9
  Defined in: [models/INormalizedSubscription.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L12)
@@ -19,7 +20,7 @@ readonly cancelAtPeriodEnd: boolean;
19
20
 
20
21
  Defined in: [models/INormalizedSubscription.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L19)
21
22
 
22
- ***
23
+ ---
23
24
 
24
25
  ### currentPeriodEnd
25
26
 
@@ -29,7 +30,7 @@ readonly currentPeriodEnd: Date;
29
30
 
30
31
  Defined in: [models/INormalizedSubscription.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L18)
31
32
 
32
- ***
33
+ ---
33
34
 
34
35
  ### currentPeriodStart
35
36
 
@@ -39,7 +40,7 @@ readonly currentPeriodStart: Date;
39
40
 
40
41
  Defined in: [models/INormalizedSubscription.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L17)
41
42
 
42
- ***
43
+ ---
43
44
 
44
45
  ### customerId
45
46
 
@@ -49,7 +50,7 @@ readonly customerId: string;
49
50
 
50
51
  Defined in: [models/INormalizedSubscription.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L14)
51
52
 
52
- ***
53
+ ---
53
54
 
54
55
  ### id
55
56
 
@@ -59,7 +60,7 @@ readonly id: string;
59
60
 
60
61
  Defined in: [models/INormalizedSubscription.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L13)
61
62
 
62
- ***
63
+ ---
63
64
 
64
65
  ### priceId
65
66
 
@@ -69,7 +70,7 @@ readonly priceId: string;
69
70
 
70
71
  Defined in: [models/INormalizedSubscription.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L16)
71
72
 
72
- ***
73
+ ---
73
74
 
74
75
  ### status
75
76
 
@@ -79,7 +80,7 @@ readonly status: SubscriptionStatus;
79
80
 
80
81
  Defined in: [models/INormalizedSubscription.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L15)
81
82
 
82
- ***
83
+ ---
83
84
 
84
85
  ### trialEnd
85
86
 
@@ -89,7 +90,7 @@ readonly trialEnd: Date | null;
89
90
 
90
91
  Defined in: [models/INormalizedSubscription.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L21)
91
92
 
92
- ***
93
+ ---
93
94
 
94
95
  ### trialStart
95
96
 
@@ -3,6 +3,7 @@ title: 'Interface: INormalizedWebhookEvent'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Interface: INormalizedWebhookEvent
7
8
 
8
9
  Defined in: [models/INormalizedWebhookEvent.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedWebhookEvent.ts#L13)
@@ -67,12 +68,12 @@ readonly subscriptionId: string | null;
67
68
  readonly optional subscription?: INormalizedSubscription;
68
69
  ```
69
70
 
70
- ***
71
+ ---
71
72
 
72
73
  ### type
73
74
 
74
75
  ```ts
75
- readonly type:
76
+ readonly type:
76
77
  | "checkout.session.completed"
77
78
  | "subscription.updated"
78
79
  | "subscription.deleted"
@@ -3,6 +3,7 @@ title: 'Interface: IPaymentModuleOptions'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Interface: IPaymentModuleOptions
7
8
 
8
9
  Defined in: [PaymentModule.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/PaymentModule.ts#L19)
@@ -21,7 +22,7 @@ Defined in: [PaymentModule.ts:29](https://github.com/RueDeRennes/archipel/blob/m
21
22
 
22
23
  Provider-specific configuration entries to register with the config module.
23
24
 
24
- ***
25
+ ---
25
26
 
26
27
  ### featureAccess?
27
28
 
@@ -34,7 +35,7 @@ Defined in: [PaymentModule.ts:35](https://github.com/RueDeRennes/archipel/blob/m
34
35
  Concrete implementation of the [FeatureAccessPort](Class.FeatureAccessPort).
35
36
  Required when using `FeatureGuard` or `FeatureUsageInterceptor`.
36
37
 
37
- ***
38
+ ---
38
39
 
39
40
  ### isGlobal?
40
41
 
@@ -46,7 +47,7 @@ Defined in: [PaymentModule.ts:40](https://github.com/RueDeRennes/archipel/blob/m
46
47
 
47
48
  When `true` the module is registered globally.
48
49
 
49
- ***
50
+ ---
50
51
 
51
52
  ### paymentClient
52
53
 
@@ -3,18 +3,19 @@ title: 'Type Alias: SubscriptionStatus'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Type Alias: SubscriptionStatus
7
8
 
8
9
  ```ts
9
- type SubscriptionStatus =
10
- | "active"
11
- | "canceled"
12
- | "incomplete"
13
- | "incompleteExpired"
14
- | "pastDue"
15
- | "trialing"
16
- | "unpaid"
17
- | "paused";
10
+ type SubscriptionStatus =
11
+ | 'active'
12
+ | 'canceled'
13
+ | 'incomplete'
14
+ | 'incompleteExpired'
15
+ | 'pastDue'
16
+ | 'trialing'
17
+ | 'unpaid'
18
+ | 'paused';
18
19
  ```
19
20
 
20
21
  Defined in: [models/SubscriptionStatus.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/SubscriptionStatus.ts#L6)
@@ -3,10 +3,11 @@ title: 'Variable: FEATURE\_KEY\_METADATA'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
- # Variable: FEATURE\_KEY\_METADATA
6
+
7
+ # Variable: FEATURE_KEY_METADATA
7
8
 
8
9
  ```ts
9
- const FEATURE_KEY_METADATA: "feature_key" = 'feature_key';
10
+ const FEATURE_KEY_METADATA: 'feature_key' = 'feature_key';
10
11
  ```
11
12
 
12
13
  Defined in: [guards/FeatureGuard.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/guards/FeatureGuard.ts#L9)
@@ -3,7 +3,8 @@ title: 'Variable: LEMONSQUEEZY\_API\_KEY'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
- # Variable: LEMONSQUEEZY\_API\_KEY
6
+
7
+ # Variable: LEMONSQUEEZY_API_KEY
7
8
 
8
9
  ```ts
9
10
  const LEMONSQUEEZY_API_KEY: IConfigKey<string>;
@@ -3,10 +3,11 @@ title: 'Variable: LEMONSQUEEZY\_CONFIG\_ENTRIES'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
- # Variable: LEMONSQUEEZY\_CONFIG\_ENTRIES
6
+
7
+ # Variable: LEMONSQUEEZY_CONFIG_ENTRIES
7
8
 
8
9
  ```ts
9
- const LEMONSQUEEZY_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
10
+ const LEMONSQUEEZY_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
10
11
  ```
11
12
 
12
13
  Defined in: [lemonsqueezy/env.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/env.ts#L25)
@@ -3,7 +3,8 @@ title: 'Variable: LEMONSQUEEZY\_STORE\_ID'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
- # Variable: LEMONSQUEEZY\_STORE\_ID
6
+
7
+ # Variable: LEMONSQUEEZY_STORE_ID
7
8
 
8
9
  ```ts
9
10
  const LEMONSQUEEZY_STORE_ID: IConfigKey<string>;
@@ -3,7 +3,8 @@ title: 'Variable: LEMONSQUEEZY\_WEBHOOK\_SECRET'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
- # Variable: LEMONSQUEEZY\_WEBHOOK\_SECRET
6
+
7
+ # Variable: LEMONSQUEEZY_WEBHOOK_SECRET
7
8
 
8
9
  ```ts
9
10
  const LEMONSQUEEZY_WEBHOOK_SECRET: IConfigKey<string>;
@@ -3,7 +3,8 @@ title: 'Variable: MOLLIE\_API\_KEY'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
- # Variable: MOLLIE\_API\_KEY
6
+
7
+ # Variable: MOLLIE_API_KEY
7
8
 
8
9
  ```ts
9
10
  const MOLLIE_API_KEY: IConfigKey<string>;
@@ -3,10 +3,11 @@ title: 'Variable: MOLLIE\_CONFIG\_ENTRIES'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
- # Variable: MOLLIE\_CONFIG\_ENTRIES
6
+
7
+ # Variable: MOLLIE_CONFIG_ENTRIES
7
8
 
8
9
  ```ts
9
- const MOLLIE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
10
+ const MOLLIE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
10
11
  ```
11
12
 
12
13
  Defined in: [mollie/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/env.ts#L22)
@@ -3,7 +3,8 @@ title: 'Variable: MOLLIE\_WEBHOOK\_SECRET'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
- # Variable: MOLLIE\_WEBHOOK\_SECRET
6
+
7
+ # Variable: MOLLIE_WEBHOOK_SECRET
7
8
 
8
9
  ```ts
9
10
  const MOLLIE_WEBHOOK_SECRET: IConfigKey<string>;
@@ -3,7 +3,8 @@ title: 'Variable: PADDLE\_API\_KEY'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
- # Variable: PADDLE\_API\_KEY
6
+
7
+ # Variable: PADDLE_API_KEY
7
8
 
8
9
  ```ts
9
10
  const PADDLE_API_KEY: IConfigKey<string>;
@@ -3,10 +3,11 @@ title: 'Variable: PADDLE\_CONFIG\_ENTRIES'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
- # Variable: PADDLE\_CONFIG\_ENTRIES
6
+
7
+ # Variable: PADDLE_CONFIG_ENTRIES
7
8
 
8
9
  ```ts
9
- const PADDLE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
10
+ const PADDLE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
10
11
  ```
11
12
 
12
13
  Defined in: [paddle/env.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/env.ts#L25)
@@ -3,7 +3,8 @@ title: 'Variable: PADDLE\_ENVIRONMENT'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
- # Variable: PADDLE\_ENVIRONMENT
6
+
7
+ # Variable: PADDLE_ENVIRONMENT
7
8
 
8
9
  ```ts
9
10
  const PADDLE_ENVIRONMENT: IConfigKey<string>;
@@ -3,7 +3,8 @@ title: 'Variable: PADDLE\_WEBHOOK\_SECRET'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
- # Variable: PADDLE\_WEBHOOK\_SECRET
6
+
7
+ # Variable: PADDLE_WEBHOOK_SECRET
7
8
 
8
9
  ```ts
9
10
  const PADDLE_WEBHOOK_SECRET: IConfigKey<string>;
@@ -3,7 +3,8 @@ title: 'Variable: STRIPE\_API\_KEY'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
- # Variable: STRIPE\_API\_KEY
6
+
7
+ # Variable: STRIPE_API_KEY
7
8
 
8
9
  ```ts
9
10
  const STRIPE_API_KEY: IConfigKey<string>;
@@ -3,10 +3,11 @@ title: 'Variable: STRIPE\_CONFIG\_ENTRIES'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
- # Variable: STRIPE\_CONFIG\_ENTRIES
6
+
7
+ # Variable: STRIPE_CONFIG_ENTRIES
7
8
 
8
9
  ```ts
9
- const STRIPE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
10
+ const STRIPE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
10
11
  ```
11
12
 
12
13
  Defined in: [stripe/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/env.ts#L22)
@@ -3,7 +3,8 @@ title: 'Variable: STRIPE\_WEBHOOK\_SECRET'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
- # Variable: STRIPE\_WEBHOOK\_SECRET
6
+
7
+ # Variable: STRIPE_WEBHOOK_SECRET
7
8
 
8
9
  ```ts
9
10
  const STRIPE_WEBHOOK_SECRET: IConfigKey<string>;
@@ -3,61 +3,62 @@ title: '@breadstone/archipel-platform-payments'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # @breadstone/archipel-platform-payments
7
8
 
8
9
  ## Classes
9
10
 
10
- | Class | Description |
11
- | ------ | ------ |
12
- | [FeatureAccessPort](Class.FeatureAccessPort) | Abstract port for checking and recording feature usage. Consuming projects must provide a concrete implementation (e.g. backed by Prisma with subscription + usage tables) and register it via `PaymentModule.register()`. |
13
- | [FeatureGuard](Class.FeatureGuard) | Guard that checks if the user has access to a specific feature by delegating to the registered [FeatureAccessPort](Class.FeatureAccessPort). |
14
- | [FeatureUsageInterceptor](Class.FeatureUsageInterceptor) | Interceptor that records feature usage after successful request handling. Delegates recording to the registered [FeatureAccessPort](Class.FeatureAccessPort). |
15
- | [LemonSqueezyClient](Class.LemonSqueezyClient) | LemonSqueezy implementation of the [PaymentClientPort](Class.PaymentClientPort). Uses the official `@lemonsqueezy/lemonsqueezy.js` SDK. |
16
- | [MollieClient](Class.MollieClient) | Mollie implementation of the [PaymentClientPort](Class.PaymentClientPort). Uses the official `@mollie/api-client` to interact with the Mollie API. |
17
- | [PaddleClient](Class.PaddleClient) | Paddle implementation of the [PaymentClientPort](Class.PaymentClientPort). Uses the official `@paddle/paddle-node-sdk` to interact with the Paddle Billing API. |
18
- | [PaymentClientPort](Class.PaymentClientPort) | Abstract port for payment provider clients. Each provider (Stripe, Paddle, LemonSqueezy, Mollie) must implement this contract so that the consuming application can switch providers without changing business logic. |
19
- | [PaymentModule](Class.PaymentModule) | NestJS module providing generic payment infrastructure. Exposes a configurable payment client, a feature-gating guard, and a usage-tracking interceptor. The specific payment provider (Stripe, Paddle, LemonSqueezy, Mollie) is selected via the options. |
20
- | [StripeClient](Class.StripeClient) | Stripe implementation of the [PaymentClientPort](Class.PaymentClientPort). All Stripe-specific types and logic are encapsulated here. |
11
+ | Class | Description |
12
+ | -------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
+ | [FeatureAccessPort](Class.FeatureAccessPort) | Abstract port for checking and recording feature usage. Consuming projects must provide a concrete implementation (e.g. backed by Prisma with subscription + usage tables) and register it via `PaymentModule.register()`. |
14
+ | [FeatureGuard](Class.FeatureGuard) | Guard that checks if the user has access to a specific feature by delegating to the registered [FeatureAccessPort](Class.FeatureAccessPort). |
15
+ | [FeatureUsageInterceptor](Class.FeatureUsageInterceptor) | Interceptor that records feature usage after successful request handling. Delegates recording to the registered [FeatureAccessPort](Class.FeatureAccessPort). |
16
+ | [LemonSqueezyClient](Class.LemonSqueezyClient) | LemonSqueezy implementation of the [PaymentClientPort](Class.PaymentClientPort). Uses the official `@lemonsqueezy/lemonsqueezy.js` SDK. |
17
+ | [MollieClient](Class.MollieClient) | Mollie implementation of the [PaymentClientPort](Class.PaymentClientPort). Uses the official `@mollie/api-client` to interact with the Mollie API. |
18
+ | [PaddleClient](Class.PaddleClient) | Paddle implementation of the [PaymentClientPort](Class.PaymentClientPort). Uses the official `@paddle/paddle-node-sdk` to interact with the Paddle Billing API. |
19
+ | [PaymentClientPort](Class.PaymentClientPort) | Abstract port for payment provider clients. Each provider (Stripe, Paddle, LemonSqueezy, Mollie) must implement this contract so that the consuming application can switch providers without changing business logic. |
20
+ | [PaymentModule](Class.PaymentModule) | NestJS module providing generic payment infrastructure. Exposes a configurable payment client, a feature-gating guard, and a usage-tracking interceptor. The specific payment provider (Stripe, Paddle, LemonSqueezy, Mollie) is selected via the options. |
21
+ | [StripeClient](Class.StripeClient) | Stripe implementation of the [PaymentClientPort](Class.PaymentClientPort). All Stripe-specific types and logic are encapsulated here. |
21
22
 
22
23
  ## Interfaces
23
24
 
24
- | Interface | Description |
25
- | ------ | ------ |
26
- | [IFeatureAccessResult](Interface.IFeatureAccessResult) | Result of a feature access check. |
27
- | [INormalizedCheckoutSession](Interface.INormalizedCheckoutSession) | Normalized checkout session. |
28
- | [INormalizedPrice](Interface.INormalizedPrice) | Normalized price information. |
29
- | [INormalizedSubscription](Interface.INormalizedSubscription) | Normalized subscription. |
30
- | [INormalizedWebhookEvent](Interface.INormalizedWebhookEvent) | Normalized webhook event. |
31
- | [IPaymentModuleOptions](Interface.IPaymentModuleOptions) | Configuration options for the `PaymentModule`. |
25
+ | Interface | Description |
26
+ | ------------------------------------------------------------------ | ---------------------------------------------- |
27
+ | [IFeatureAccessResult](Interface.IFeatureAccessResult) | Result of a feature access check. |
28
+ | [INormalizedCheckoutSession](Interface.INormalizedCheckoutSession) | Normalized checkout session. |
29
+ | [INormalizedPrice](Interface.INormalizedPrice) | Normalized price information. |
30
+ | [INormalizedSubscription](Interface.INormalizedSubscription) | Normalized subscription. |
31
+ | [INormalizedWebhookEvent](Interface.INormalizedWebhookEvent) | Normalized webhook event. |
32
+ | [IPaymentModuleOptions](Interface.IPaymentModuleOptions) | Configuration options for the `PaymentModule`. |
32
33
 
33
34
  ## Type Aliases
34
35
 
35
- | Type Alias | Description |
36
- | ------ | ------ |
36
+ | Type Alias | Description |
37
+ | -------------------------------------------------- | -------------------------------------- |
37
38
  | [SubscriptionStatus](TypeAlias.SubscriptionStatus) | Normalized subscription status values. |
38
39
 
39
40
  ## Variables
40
41
 
41
- | Variable | Description |
42
- | ------ | ------ |
43
- | [FEATURE\_KEY\_METADATA](Variable.FEATURE_KEY_METADATA) | - |
44
- | [LEMONSQUEEZY\_API\_KEY](Variable.LEMONSQUEEZY_API_KEY) | LemonSqueezy API key. |
45
- | [LEMONSQUEEZY\_CONFIG\_ENTRIES](Variable.LEMONSQUEEZY_CONFIG_ENTRIES) | Configuration entries required by the LemonSqueezy payment provider. |
46
- | [LEMONSQUEEZY\_STORE\_ID](Variable.LEMONSQUEEZY_STORE_ID) | LemonSqueezy store ID. |
47
- | [LEMONSQUEEZY\_WEBHOOK\_SECRET](Variable.LEMONSQUEEZY_WEBHOOK_SECRET) | LemonSqueezy webhook signing secret. |
48
- | [MOLLIE\_API\_KEY](Variable.MOLLIE_API_KEY) | Mollie API key. |
49
- | [MOLLIE\_CONFIG\_ENTRIES](Variable.MOLLIE_CONFIG_ENTRIES) | Configuration entries required by the Mollie payment provider. |
50
- | [MOLLIE\_WEBHOOK\_SECRET](Variable.MOLLIE_WEBHOOK_SECRET) | Mollie webhook secret for verifying webhook payloads. |
51
- | [PADDLE\_API\_KEY](Variable.PADDLE_API_KEY) | Paddle API key. |
52
- | [PADDLE\_CONFIG\_ENTRIES](Variable.PADDLE_CONFIG_ENTRIES) | Configuration entries required by the Paddle payment provider. |
53
- | [PADDLE\_ENVIRONMENT](Variable.PADDLE_ENVIRONMENT) | Paddle environment (`production` or `sandbox`). Defaults to `production`. |
54
- | [PADDLE\_WEBHOOK\_SECRET](Variable.PADDLE_WEBHOOK_SECRET) | Paddle webhook secret key. |
55
- | [STRIPE\_API\_KEY](Variable.STRIPE_API_KEY) | Stripe secret API key. |
56
- | [STRIPE\_CONFIG\_ENTRIES](Variable.STRIPE_CONFIG_ENTRIES) | Configuration entries required by the Stripe payment provider. |
57
- | [STRIPE\_WEBHOOK\_SECRET](Variable.STRIPE_WEBHOOK_SECRET) | Stripe webhook signing secret. |
42
+ | Variable | Description |
43
+ | ------------------------------------------------------------------- | ------------------------------------------------------------------------- |
44
+ | [FEATURE_KEY_METADATA](Variable.FEATURE_KEY_METADATA) | - |
45
+ | [LEMONSQUEEZY_API_KEY](Variable.LEMONSQUEEZY_API_KEY) | LemonSqueezy API key. |
46
+ | [LEMONSQUEEZY_CONFIG_ENTRIES](Variable.LEMONSQUEEZY_CONFIG_ENTRIES) | Configuration entries required by the LemonSqueezy payment provider. |
47
+ | [LEMONSQUEEZY_STORE_ID](Variable.LEMONSQUEEZY_STORE_ID) | LemonSqueezy store ID. |
48
+ | [LEMONSQUEEZY_WEBHOOK_SECRET](Variable.LEMONSQUEEZY_WEBHOOK_SECRET) | LemonSqueezy webhook signing secret. |
49
+ | [MOLLIE_API_KEY](Variable.MOLLIE_API_KEY) | Mollie API key. |
50
+ | [MOLLIE_CONFIG_ENTRIES](Variable.MOLLIE_CONFIG_ENTRIES) | Configuration entries required by the Mollie payment provider. |
51
+ | [MOLLIE_WEBHOOK_SECRET](Variable.MOLLIE_WEBHOOK_SECRET) | Mollie webhook secret for verifying webhook payloads. |
52
+ | [PADDLE_API_KEY](Variable.PADDLE_API_KEY) | Paddle API key. |
53
+ | [PADDLE_CONFIG_ENTRIES](Variable.PADDLE_CONFIG_ENTRIES) | Configuration entries required by the Paddle payment provider. |
54
+ | [PADDLE_ENVIRONMENT](Variable.PADDLE_ENVIRONMENT) | Paddle environment (`production` or `sandbox`). Defaults to `production`. |
55
+ | [PADDLE_WEBHOOK_SECRET](Variable.PADDLE_WEBHOOK_SECRET) | Paddle webhook secret key. |
56
+ | [STRIPE_API_KEY](Variable.STRIPE_API_KEY) | Stripe secret API key. |
57
+ | [STRIPE_CONFIG_ENTRIES](Variable.STRIPE_CONFIG_ENTRIES) | Configuration entries required by the Stripe payment provider. |
58
+ | [STRIPE_WEBHOOK_SECRET](Variable.STRIPE_WEBHOOK_SECRET) | Stripe webhook signing secret. |
58
59
 
59
60
  ## Functions
60
61
 
61
- | Function | Description |
62
- | ------ | ------ |
62
+ | Function | Description |
63
+ | ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
63
64
  | [RequiresFeature](Function.RequiresFeature) | Decorator to mark endpoints that require feature access check. The `featureKey` is a free-form string defined by the consuming project. |
@@ -3,6 +3,7 @@ title: 'Class: ReportingContributorRegistry'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Class: ReportingContributorRegistry
7
8
 
8
9
  Defined in: [core/ReportingContributorRegistry.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/core/ReportingContributorRegistry.ts#L12)
@@ -35,7 +36,7 @@ Defined in: [core/ReportingContributorRegistry.ts:31](https://github.com/RueDeRe
35
36
 
36
37
  readonly [`IReportingContributor`](Interface.IReportingContributor)[]
37
38
 
38
- ***
39
+ ---
39
40
 
40
41
  ### register()
41
42
 
@@ -47,8 +48,8 @@ Defined in: [core/ReportingContributorRegistry.ts:23](https://github.com/RueDeRe
47
48
 
48
49
  #### Parameters
49
50
 
50
- | Parameter | Type |
51
- | ------ | ------ |
51
+ | Parameter | Type |
52
+ | ------------- | ---------------------------------------------------------- |
52
53
  | `contributor` | [`IReportingContributor`](Interface.IReportingContributor) |
53
54
 
54
55
  #### Returns
@@ -3,6 +3,7 @@ title: 'Class: ReportingDatasetNotFoundError'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Class: ReportingDatasetNotFoundError
7
8
 
8
9
  Defined in: [models/errors/ReportingDatasetNotFoundError.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/errors/ReportingDatasetNotFoundError.ts#L6)
@@ -25,8 +26,8 @@ Defined in: [models/errors/ReportingDatasetNotFoundError.ts:10](https://github.c
25
26
 
26
27
  #### Parameters
27
28
 
28
- | Parameter | Type |
29
- | ------ | ------ |
29
+ | Parameter | Type |
30
+ | ----------- | -------- |
30
31
  | `datasetId` | `string` |
31
32
 
32
33
  #### Returns
@@ -36,5 +37,5 @@ Defined in: [models/errors/ReportingDatasetNotFoundError.ts:10](https://github.c
36
37
  #### Overrides
37
38
 
38
39
  ```ts
39
- Error.constructor
40
+ Error.constructor;
40
41
  ```
@@ -3,6 +3,7 @@ title: 'Class: ReportingFacade'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Class: ReportingFacade
7
8
 
8
9
  Defined in: [core/ReportingFacade.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/core/ReportingFacade.ts#L19)
@@ -21,8 +22,8 @@ Defined in: [core/ReportingFacade.ts:31](https://github.com/RueDeRennes/archipel
21
22
 
22
23
  #### Parameters
23
24
 
24
- | Parameter | Type |
25
- | ------ | ------ |
25
+ | Parameter | Type |
26
+ | ---------- | -------------------------------------------------------------------- |
26
27
  | `registry` | [`ReportingContributorRegistry`](Class.ReportingContributorRegistry) |
27
28
 
28
29
  #### Returns
@@ -41,15 +42,15 @@ Defined in: [core/ReportingFacade.ts:52](https://github.com/RueDeRennes/archipel
41
42
 
42
43
  #### Parameters
43
44
 
44
- | Parameter | Type |
45
- | ------ | ------ |
45
+ | Parameter | Type |
46
+ | --------- | ---------------------------------------------- |
46
47
  | `request` | [`IReportingQuery`](Interface.IReportingQuery) |
47
48
 
48
49
  #### Returns
49
50
 
50
51
  `Promise`\<[`IReportingQueryResult`](Interface.IReportingQueryResult)\>
51
52
 
52
- ***
53
+ ---
53
54
 
54
55
  ### getCatalog()
55
56
 
@@ -63,7 +64,7 @@ Defined in: [core/ReportingFacade.ts:39](https://github.com/RueDeRennes/archipel
63
64
 
64
65
  `Promise`\<readonly [`IReportingDataset`](Interface.IReportingDataset)[]\>
65
66
 
66
- ***
67
+ ---
67
68
 
68
69
  ### getDataset()
69
70
 
@@ -75,8 +76,8 @@ Defined in: [core/ReportingFacade.ts:47](https://github.com/RueDeRennes/archipel
75
76
 
76
77
  #### Parameters
77
78
 
78
- | Parameter | Type |
79
- | ------ | ------ |
79
+ | Parameter | Type |
80
+ | ----------- | -------- |
80
81
  | `datasetId` | `string` |
81
82
 
82
83
  #### Returns
@@ -3,6 +3,7 @@ title: 'Class: ReportingModule'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Class: ReportingModule
7
8
 
8
9
  Defined in: [ReportingModule.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/ReportingModule.ts#L25)
@@ -3,6 +3,7 @@ title: 'Interface: IReportingContributor'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Interface: IReportingContributor
7
8
 
8
9
  Defined in: [core/ReportingContributor.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/core/ReportingContributor.ts#L12)
@@ -35,16 +36,16 @@ Executes the dataset query defined by the given request.
35
36
 
36
37
  #### Parameters
37
38
 
38
- | Parameter | Type |
39
- | ------ | ------ |
39
+ | Parameter | Type |
40
+ | ---------- | -------------------------------------------------- |
40
41
  | `_dataset` | [`IReportingDataset`](Interface.IReportingDataset) |
41
- | `_request` | [`IReportingQuery`](Interface.IReportingQuery) |
42
+ | `_request` | [`IReportingQuery`](Interface.IReportingQuery) |
42
43
 
43
44
  #### Returns
44
45
 
45
46
  `Promise`\<[`IReportingQueryResult`](Interface.IReportingQueryResult)\>
46
47
 
47
- ***
48
+ ---
48
49
 
49
50
  ### listDatasets()
50
51