@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: 'Function: Api()'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Function: Api()
7
8
 
8
9
  ```ts
@@ -16,19 +17,19 @@ This decorator wraps all necessary Swagger decorators into one.
16
17
 
17
18
  ## Parameters
18
19
 
19
- | Parameter | Type | Description |
20
- | ------ | ------ | ------ |
21
- | `options` | \{ `auth?`: `"bearer"` \| `"basic"` \| `"oauth2"` \| `"cookie"`; `body?`: `ApiBodyOptions`; `extensions?`: `Record`\<`string`, `string` \| `number` \| `boolean`\>; `headers?`: `ApiHeaderOptions`[]; `operation?`: `Partial`\<`OperationObject`\>; `params?`: `ApiParamOptions` \| `ApiParamOptions`[]; `query?`: `ApiQueryOptions` \| `ApiQueryOptions`[]; `responses?`: `ApiResponseOptions` \| `ApiResponseOptions`[]; `scopes?`: `string`[]; `tags?`: `string` \| `string`[]; \} | Configuration for the Swagger decorators. |
22
- | `options.auth?` | `"bearer"` \| `"basic"` \| `"oauth2"` \| `"cookie"` | - |
23
- | `options.body?` | `ApiBodyOptions` | Options for the ApiBody decorator. |
24
- | `options.extensions?` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | - |
25
- | `options.headers?` | `ApiHeaderOptions`[] | Options for the ApiHeaders decorator. |
26
- | `options.operation?` | `Partial`\<`OperationObject`\> | Options for the ApiOperation decorator. |
27
- | `options.params?` | `ApiParamOptions` \| `ApiParamOptions`[] | Options for the ApiParam decorator. |
28
- | `options.query?` | `ApiQueryOptions` \| `ApiQueryOptions`[] | Options for the ApiQuery decorator (can be an array or single query). |
29
- | `options.responses?` | `ApiResponseOptions` \| `ApiResponseOptions`[] | - |
30
- | `options.scopes?` | `string`[] | - |
31
- | `options.tags?` | `string` \| `string`[] | Options for the ApiTags decorator (can be an array or single tag). |
20
+ | Parameter | Type | Description |
21
+ | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
22
+ | `options` | \{ `auth?`: `"bearer"` \| `"basic"` \| `"oauth2"` \| `"cookie"`; `body?`: `ApiBodyOptions`; `extensions?`: `Record`\<`string`, `string` \| `number` \| `boolean`\>; `headers?`: `ApiHeaderOptions`[]; `operation?`: `Partial`\<`OperationObject`\>; `params?`: `ApiParamOptions` \| `ApiParamOptions`[]; `query?`: `ApiQueryOptions` \| `ApiQueryOptions`[]; `responses?`: `ApiResponseOptions` \| `ApiResponseOptions`[]; `scopes?`: `string`[]; `tags?`: `string` \| `string`[]; \} | Configuration for the Swagger decorators. |
23
+ | `options.auth?` | `"bearer"` \| `"basic"` \| `"oauth2"` \| `"cookie"` | - |
24
+ | `options.body?` | `ApiBodyOptions` | Options for the ApiBody decorator. |
25
+ | `options.extensions?` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | - |
26
+ | `options.headers?` | `ApiHeaderOptions`[] | Options for the ApiHeaders decorator. |
27
+ | `options.operation?` | `Partial`\<`OperationObject`\> | Options for the ApiOperation decorator. |
28
+ | `options.params?` | `ApiParamOptions` \| `ApiParamOptions`[] | Options for the ApiParam decorator. |
29
+ | `options.query?` | `ApiQueryOptions` \| `ApiQueryOptions`[] | Options for the ApiQuery decorator (can be an array or single query). |
30
+ | `options.responses?` | `ApiResponseOptions` \| `ApiResponseOptions`[] | - |
31
+ | `options.scopes?` | `string`[] | - |
32
+ | `options.tags?` | `string` \| `string`[] | Options for the ApiTags decorator (can be an array or single tag). |
32
33
 
33
34
  ## Returns
34
35
 
@@ -3,6 +3,7 @@ title: 'Function: SwaggerFeature()'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Function: SwaggerFeature()
7
8
 
8
9
  ```ts
@@ -16,8 +17,8 @@ This allows the SwaggerMultiDocumentService to automatically discover and create
16
17
 
17
18
  ## Parameters
18
19
 
19
- | Parameter | Type | Description |
20
- | ------ | ------ | ------ |
20
+ | Parameter | Type | Description |
21
+ | ---------- | -------------------------------------------------------------- | --------------------------------------------------- |
21
22
  | `metadata` | [`ISwaggerFeatureMetadata`](Interface.ISwaggerFeatureMetadata) | The feature configuration for Swagger documentation |
22
23
 
23
24
  ## Returns
@@ -31,12 +32,12 @@ This allows the SwaggerMultiDocumentService to automatically discover and create
31
32
  name: 'tip',
32
33
  title: 'Strivio API - Tips',
33
34
  description: 'API endpoints for tip management',
34
- tag: 'Tip'
35
+ tag: 'Tip',
35
36
  })
36
37
  @Module({
37
38
  controllers: [TipController],
38
39
  providers: [TipService],
39
- exports: [TipService]
40
+ exports: [TipService],
40
41
  })
41
42
  export class TipModule {}
42
43
  ```
@@ -3,6 +3,7 @@ title: 'Function: getRegisteredSwaggerFeatures()'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Function: getRegisteredSwaggerFeatures()
7
8
 
8
9
  ```ts
@@ -3,12 +3,11 @@ title: 'Function: getSwaggerFeatureMetadata()'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Function: getSwaggerFeatureMetadata()
7
8
 
8
9
  ```ts
9
- function getSwaggerFeatureMetadata(target):
10
- | ISwaggerFeatureMetadata
11
- | undefined;
10
+ function getSwaggerFeatureMetadata(target): ISwaggerFeatureMetadata | undefined;
12
11
  ```
13
12
 
14
13
  Defined in: [decorators/SwaggerFeature.ts:115](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L115)
@@ -17,11 +16,11 @@ Get the Swagger feature metadata from a module class
17
16
 
18
17
  ## Parameters
19
18
 
20
- | Parameter | Type |
21
- | ------ | ------ |
22
- | `target` | `any` |
19
+ | Parameter | Type |
20
+ | --------- | ----- |
21
+ | `target` | `any` |
23
22
 
24
23
  ## Returns
25
24
 
26
- \| [`ISwaggerFeatureMetadata`](Interface.ISwaggerFeatureMetadata)
27
- \| `undefined`
25
+ \| [`ISwaggerFeatureMetadata`](Interface.ISwaggerFeatureMetadata)
26
+ \| `undefined`
@@ -3,6 +3,7 @@ title: 'Interface: IFeatureSwaggerConfig'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Interface: IFeatureSwaggerConfig
7
8
 
8
9
  Defined in: [registry/IFeatureSwaggerConfig.ts:1](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L1)
@@ -17,7 +18,7 @@ readonly description: string;
17
18
 
18
19
  Defined in: [registry/IFeatureSwaggerConfig.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L4)
19
20
 
20
- ***
21
+ ---
21
22
 
22
23
  ### name
23
24
 
@@ -27,7 +28,7 @@ readonly name: string;
27
28
 
28
29
  Defined in: [registry/IFeatureSwaggerConfig.ts:2](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L2)
29
30
 
30
- ***
31
+ ---
31
32
 
32
33
  ### path
33
34
 
@@ -37,7 +38,7 @@ readonly path: string;
37
38
 
38
39
  Defined in: [registry/IFeatureSwaggerConfig.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L7)
39
40
 
40
- ***
41
+ ---
41
42
 
42
43
  ### tag
43
44
 
@@ -47,7 +48,7 @@ readonly tag: string;
47
48
 
48
49
  Defined in: [registry/IFeatureSwaggerConfig.ts:5](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L5)
49
50
 
50
- ***
51
+ ---
51
52
 
52
53
  ### tags
53
54
 
@@ -57,7 +58,7 @@ readonly tags: string[];
57
58
 
58
59
  Defined in: [registry/IFeatureSwaggerConfig.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L6)
59
60
 
60
- ***
61
+ ---
61
62
 
62
63
  ### title
63
64
 
@@ -3,6 +3,7 @@ title: 'Interface: ISwaggerFeatureMetadata'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Interface: ISwaggerFeatureMetadata
7
8
 
8
9
  Defined in: [decorators/SwaggerFeature.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L18)
@@ -17,7 +18,7 @@ readonly description: string;
17
18
 
18
19
  Defined in: [decorators/SwaggerFeature.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L21)
19
20
 
20
- ***
21
+ ---
21
22
 
22
23
  ### name
23
24
 
@@ -27,7 +28,7 @@ readonly name: string;
27
28
 
28
29
  Defined in: [decorators/SwaggerFeature.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L19)
29
30
 
30
- ***
31
+ ---
31
32
 
32
33
  ### path?
33
34
 
@@ -37,7 +38,7 @@ readonly optional path?: string;
37
38
 
38
39
  Defined in: [decorators/SwaggerFeature.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L24)
39
40
 
40
- ***
41
+ ---
41
42
 
42
43
  ### tag
43
44
 
@@ -47,7 +48,7 @@ readonly tag: string;
47
48
 
48
49
  Defined in: [decorators/SwaggerFeature.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L22)
49
50
 
50
- ***
51
+ ---
51
52
 
52
53
  ### tags
53
54
 
@@ -57,7 +58,7 @@ readonly tags: string[];
57
58
 
58
59
  Defined in: [decorators/SwaggerFeature.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L23)
59
60
 
60
- ***
61
+ ---
61
62
 
62
63
  ### title
63
64
 
@@ -3,7 +3,8 @@ title: 'Variable: APP\_VERSION'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
- # Variable: APP\_VERSION
6
+
7
+ # Variable: APP_VERSION
7
8
 
8
9
  ```ts
9
10
  const APP_VERSION: IConfigKey<string>;
@@ -3,10 +3,11 @@ title: 'Variable: PLATFORM\_OPENAPI\_CONFIG\_ENTRIES'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
- # Variable: PLATFORM\_OPENAPI\_CONFIG\_ENTRIES
6
+
7
+ # Variable: PLATFORM_OPENAPI_CONFIG_ENTRIES
7
8
 
8
9
  ```ts
9
- const PLATFORM_OPENAPI_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
10
+ const PLATFORM_OPENAPI_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
10
11
  ```
11
12
 
12
13
  Defined in: [env.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/env.ts#L28)
@@ -3,7 +3,8 @@ title: 'Variable: SWAGGER\_CONTACT\_EMAIL'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
- # Variable: SWAGGER\_CONTACT\_EMAIL
6
+
7
+ # Variable: SWAGGER_CONTACT_EMAIL
7
8
 
8
9
  ```ts
9
10
  const SWAGGER_CONTACT_EMAIL: IConfigKey<string>;
@@ -3,7 +3,8 @@ title: 'Variable: SWAGGER\_CONTACT\_NAME'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
- # Variable: SWAGGER\_CONTACT\_NAME
6
+
7
+ # Variable: SWAGGER_CONTACT_NAME
7
8
 
8
9
  ```ts
9
10
  const SWAGGER_CONTACT_NAME: IConfigKey<string>;
@@ -3,7 +3,8 @@ title: 'Variable: SWAGGER\_CONTACT\_URL'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
- # Variable: SWAGGER\_CONTACT\_URL
6
+
7
+ # Variable: SWAGGER_CONTACT_URL
7
8
 
8
9
  ```ts
9
10
  const SWAGGER_CONTACT_URL: IConfigKey<string>;
@@ -3,10 +3,11 @@ title: 'Variable: SWAGGER\_FEATURE\_METADATA\_KEY'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
- # Variable: SWAGGER\_FEATURE\_METADATA\_KEY
6
+
7
+ # Variable: SWAGGER_FEATURE_METADATA_KEY
7
8
 
8
9
  ```ts
9
- const SWAGGER_FEATURE_METADATA_KEY: "swagger:feature" = 'swagger:feature';
10
+ const SWAGGER_FEATURE_METADATA_KEY: 'swagger:feature' = 'swagger:feature';
10
11
  ```
11
12
 
12
13
  Defined in: [decorators/SwaggerFeature.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L9)
@@ -3,40 +3,41 @@ title: '@breadstone/archipel-platform-openapi'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # @breadstone/archipel-platform-openapi
7
8
 
8
9
  ## Classes
9
10
 
10
- | Class | Description |
11
- | ------ | ------ |
12
- | [SwaggerFeatureDiscovery](Class.SwaggerFeatureDiscovery) | Centralizes the discovery of Swagger features declared across backend modules. |
13
- | [SwaggerFeatureRegistry](Class.SwaggerFeatureRegistry) | Registry service for dynamically discovered Swagger features. Collects feature configurations from |
14
- | [SwaggerMultiDocumentService](Class.SwaggerMultiDocumentService) | - |
15
- | [SwaggerTheme](Class.SwaggerTheme) | The swagger theme class |
11
+ | Class | Description |
12
+ | ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
13
+ | [SwaggerFeatureDiscovery](Class.SwaggerFeatureDiscovery) | Centralizes the discovery of Swagger features declared across backend modules. |
14
+ | [SwaggerFeatureRegistry](Class.SwaggerFeatureRegistry) | Registry service for dynamically discovered Swagger features. Collects feature configurations from |
15
+ | [SwaggerMultiDocumentService](Class.SwaggerMultiDocumentService) | - |
16
+ | [SwaggerTheme](Class.SwaggerTheme) | The swagger theme class |
16
17
 
17
18
  ## Interfaces
18
19
 
19
- | Interface | Description |
20
- | ------ | ------ |
21
- | [IFeatureSwaggerConfig](Interface.IFeatureSwaggerConfig) | - |
22
- | [ISwaggerFeatureMetadata](Interface.ISwaggerFeatureMetadata) | - |
20
+ | Interface | Description |
21
+ | ------------------------------------------------------------ | ----------- |
22
+ | [IFeatureSwaggerConfig](Interface.IFeatureSwaggerConfig) | - |
23
+ | [ISwaggerFeatureMetadata](Interface.ISwaggerFeatureMetadata) | - |
23
24
 
24
25
  ## Variables
25
26
 
26
- | Variable | Description |
27
- | ------ | ------ |
28
- | [APP\_VERSION](Variable.APP_VERSION) | Application version shown in the Swagger document. |
29
- | [PLATFORM\_OPENAPI\_CONFIG\_ENTRIES](Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES) | All configuration entries required by `platform-openapi`. |
30
- | [SWAGGER\_CONTACT\_EMAIL](Variable.SWAGGER_CONTACT_EMAIL) | Contact e-mail displayed in the Swagger document. |
31
- | [SWAGGER\_CONTACT\_NAME](Variable.SWAGGER_CONTACT_NAME) | Contact name displayed in the Swagger document. |
32
- | [SWAGGER\_CONTACT\_URL](Variable.SWAGGER_CONTACT_URL) | Contact URL displayed in the Swagger document. |
33
- | [SWAGGER\_FEATURE\_METADATA\_KEY](Variable.SWAGGER_FEATURE_METADATA_KEY) | - |
27
+ | Variable | Description |
28
+ | --------------------------------------------------------------------------- | --------------------------------------------------------- |
29
+ | [APP_VERSION](Variable.APP_VERSION) | Application version shown in the Swagger document. |
30
+ | [PLATFORM_OPENAPI_CONFIG_ENTRIES](Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES) | All configuration entries required by `platform-openapi`. |
31
+ | [SWAGGER_CONTACT_EMAIL](Variable.SWAGGER_CONTACT_EMAIL) | Contact e-mail displayed in the Swagger document. |
32
+ | [SWAGGER_CONTACT_NAME](Variable.SWAGGER_CONTACT_NAME) | Contact name displayed in the Swagger document. |
33
+ | [SWAGGER_CONTACT_URL](Variable.SWAGGER_CONTACT_URL) | Contact URL displayed in the Swagger document. |
34
+ | [SWAGGER_FEATURE_METADATA_KEY](Variable.SWAGGER_FEATURE_METADATA_KEY) | - |
34
35
 
35
36
  ## Functions
36
37
 
37
- | Function | Description |
38
- | ------ | ------ |
39
- | [Api](Function.Api) | Custom Swagger Decorator This decorator wraps all necessary Swagger decorators into one. |
40
- | [getRegisteredSwaggerFeatures](Function.getRegisteredSwaggerFeatures) | Retrieves all Swagger features that have been registered through the decorator. |
41
- | [getSwaggerFeatureMetadata](Function.getSwaggerFeatureMetadata) | Get the Swagger feature metadata from a module class |
42
- | [SwaggerFeature](Function.SwaggerFeature) | Decorator to register a module as a Swagger feature. This allows the SwaggerMultiDocumentService to automatically discover and create documentation. |
38
+ | Function | Description |
39
+ | --------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
40
+ | [Api](Function.Api) | Custom Swagger Decorator This decorator wraps all necessary Swagger decorators into one. |
41
+ | [getRegisteredSwaggerFeatures](Function.getRegisteredSwaggerFeatures) | Retrieves all Swagger features that have been registered through the decorator. |
42
+ | [getSwaggerFeatureMetadata](Function.getSwaggerFeatureMetadata) | Get the Swagger feature metadata from a module class |
43
+ | [SwaggerFeature](Function.SwaggerFeature) | Decorator to register a module as a Swagger feature. This allows the SwaggerMultiDocumentService to automatically discover and create documentation. |
@@ -3,6 +3,7 @@ title: 'Abstract Class: FeatureAccessPort'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Abstract Class: FeatureAccessPort
7
8
 
8
9
  Defined in: [contracts/FeatureAccessPort.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/contracts/FeatureAccessPort.ts#L14)
@@ -38,9 +39,9 @@ without incrementing usage.
38
39
 
39
40
  #### Parameters
40
41
 
41
- | Parameter | Type | Description |
42
- | ------ | ------ | ------ |
43
- | `userId` | `string` | The user identifier. |
42
+ | Parameter | Type | Description |
43
+ | ------------ | -------- | ------------------------- |
44
+ | `userId` | `string` | The user identifier. |
44
45
  | `featureKey` | `string` | The feature key to check. |
45
46
 
46
47
  #### Returns
@@ -49,7 +50,7 @@ without incrementing usage.
49
50
 
50
51
  The access check result including quota information.
51
52
 
52
- ***
53
+ ---
53
54
 
54
55
  ### recordUsage()
55
56
 
@@ -64,9 +65,9 @@ throw if the quota has been exceeded.
64
65
 
65
66
  #### Parameters
66
67
 
67
- | Parameter | Type | Description |
68
- | ------ | ------ | ------ |
69
- | `userId` | `string` | The user identifier. |
68
+ | Parameter | Type | Description |
69
+ | ------------ | -------- | ------------------------------------ |
70
+ | `userId` | `string` | The user identifier. |
70
71
  | `featureKey` | `string` | The feature key to record usage for. |
71
72
 
72
73
  #### Returns
@@ -3,6 +3,7 @@ title: 'Class: FeatureGuard'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Class: FeatureGuard
7
8
 
8
9
  Defined in: [guards/FeatureGuard.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/guards/FeatureGuard.ts#L26)
@@ -28,10 +29,10 @@ Constructs a new instance of the `FeatureGuard` class.
28
29
 
29
30
  #### Parameters
30
31
 
31
- | Parameter | Type | Description |
32
- | ------ | ------ | ------ |
32
+ | Parameter | Type | Description |
33
+ | ------------------- | ---------------------------------------------- | ------------------------ |
33
34
  | `featureAccessPort` | [`FeatureAccessPort`](Class.FeatureAccessPort) | The feature access port. |
34
- | `reflector` | `Reflector` | The NestJS reflector. |
35
+ | `reflector` | `Reflector` | The NestJS reflector. |
35
36
 
36
37
  #### Returns
37
38
 
@@ -51,8 +52,8 @@ Determines whether the current user has access to the guarded feature.
51
52
 
52
53
  #### Parameters
53
54
 
54
- | Parameter | Type | Description |
55
- | ------ | ------ | ------ |
55
+ | Parameter | Type | Description |
56
+ | --------- | ------------------ | ---------------------- |
56
57
  | `context` | `ExecutionContext` | The execution context. |
57
58
 
58
59
  #### Returns
@@ -64,5 +65,5 @@ Determines whether the current user has access to the guarded feature.
64
65
  #### Implementation of
65
66
 
66
67
  ```ts
67
- CanActivate.canActivate
68
+ CanActivate.canActivate;
68
69
  ```
@@ -3,6 +3,7 @@ title: 'Class: FeatureUsageInterceptor'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Class: FeatureUsageInterceptor
7
8
 
8
9
  Defined in: [interceptors/FeatureUsageInterceptor.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/interceptors/FeatureUsageInterceptor.ts#L19)
@@ -28,10 +29,10 @@ Constructs a new instance of the `FeatureUsageInterceptor` class.
28
29
 
29
30
  #### Parameters
30
31
 
31
- | Parameter | Type | Description |
32
- | ------ | ------ | ------ |
32
+ | Parameter | Type | Description |
33
+ | ------------------- | ---------------------------------------------- | ------------------------ |
33
34
  | `featureAccessPort` | [`FeatureAccessPort`](Class.FeatureAccessPort) | The feature access port. |
34
- | `reflector` | `Reflector` | The NestJS reflector. |
35
+ | `reflector` | `Reflector` | The NestJS reflector. |
35
36
 
36
37
  #### Returns
37
38
 
@@ -51,10 +52,10 @@ Records feature usage after the request handler completes successfully.
51
52
 
52
53
  #### Parameters
53
54
 
54
- | Parameter | Type | Description |
55
- | ------ | ------ | ------ |
55
+ | Parameter | Type | Description |
56
+ | --------- | ------------------ | ---------------------- |
56
57
  | `context` | `ExecutionContext` | The execution context. |
57
- | `next` | `CallHandler` | The call handler. |
58
+ | `next` | `CallHandler` | The call handler. |
58
59
 
59
60
  #### Returns
60
61
 
@@ -65,5 +66,5 @@ The observable response stream.
65
66
  #### Implementation of
66
67
 
67
68
  ```ts
68
- NestInterceptor.intercept
69
+ NestInterceptor.intercept;
69
70
  ```
@@ -3,6 +3,7 @@ title: 'Class: LemonSqueezyClient'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Class: LemonSqueezyClient
7
8
 
8
9
  Defined in: [lemonsqueezy/LemonSqueezyClient.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L29)
@@ -26,8 +27,8 @@ Defined in: [lemonsqueezy/LemonSqueezyClient.ts:39](https://github.com/RueDeRenn
26
27
 
27
28
  #### Parameters
28
29
 
29
- | Parameter | Type |
30
- | ------ | ------ |
30
+ | Parameter | Type |
31
+ | --------------- | --------------- |
31
32
  | `configService` | `ConfigService` |
32
33
 
33
34
  #### Returns
@@ -52,10 +53,10 @@ Construct and normalize a webhook event from raw payload.
52
53
 
53
54
  #### Parameters
54
55
 
55
- | Parameter | Type | Description |
56
- | ------ | ------ | ------ |
57
- | `payload` | `string` \| `Buffer`\<`ArrayBufferLike`\> | Raw webhook body. |
58
- | `signature` | `string` | Webhook signature header. |
56
+ | Parameter | Type | Description |
57
+ | ----------- | ----------------------------------------- | ------------------------- |
58
+ | `payload` | `string` \| `Buffer`\<`ArrayBufferLike`\> | Raw webhook body. |
59
+ | `signature` | `string` | Webhook signature header. |
59
60
 
60
61
  #### Returns
61
62
 
@@ -67,15 +68,15 @@ Normalized webhook event.
67
68
 
68
69
  [`PaymentClientPort`](Class.PaymentClientPort).[`constructWebhookEvent`](Class.PaymentClientPort#constructwebhookevent)
69
70
 
70
- ***
71
+ ---
71
72
 
72
73
  ### createCheckoutSession()
73
74
 
74
75
  ```ts
75
76
  createCheckoutSession(
76
- priceId,
77
- successUrl,
78
- _cancelUrl,
77
+ priceId,
78
+ successUrl,
79
+ _cancelUrl,
79
80
  userId?): Promise<INormalizedCheckoutSession>;
80
81
  ```
81
82
 
@@ -85,12 +86,12 @@ Create a checkout session.
85
86
 
86
87
  #### Parameters
87
88
 
88
- | Parameter | Type | Description |
89
- | ------ | ------ | ------ |
90
- | `priceId` | `string` | Price identifier. |
91
- | `successUrl` | `string` | Success redirect URL. |
92
- | `_cancelUrl` | `string` | Cancel redirect URL. |
93
- | `userId?` | `string` | Optional user reference. |
89
+ | Parameter | Type | Description |
90
+ | ------------ | -------- | ------------------------ |
91
+ | `priceId` | `string` | Price identifier. |
92
+ | `successUrl` | `string` | Success redirect URL. |
93
+ | `_cancelUrl` | `string` | Cancel redirect URL. |
94
+ | `userId?` | `string` | Optional user reference. |
94
95
 
95
96
  #### Returns
96
97
 
@@ -102,7 +103,7 @@ Normalized checkout session.
102
103
 
103
104
  [`PaymentClientPort`](Class.PaymentClientPort).[`createCheckoutSession`](Class.PaymentClientPort#createcheckoutsession)
104
105
 
105
- ***
106
+ ---
106
107
 
107
108
  ### fetchPrices()
108
109
 
@@ -116,8 +117,8 @@ Fetch all active prices for a product.
116
117
 
117
118
  #### Parameters
118
119
 
119
- | Parameter | Type | Description |
120
- | ------ | ------ | ------ |
120
+ | Parameter | Type | Description |
121
+ | ----------- | -------- | ---------------------------- |
121
122
  | `productId` | `string` | External product identifier. |
122
123
 
123
124
  #### Returns
@@ -130,7 +131,7 @@ Array of normalized prices.
130
131
 
131
132
  [`PaymentClientPort`](Class.PaymentClientPort).[`fetchPrices`](Class.PaymentClientPort#fetchprices)
132
133
 
133
- ***
134
+ ---
134
135
 
135
136
  ### fetchSubscription()
136
137
 
@@ -146,15 +147,15 @@ Retrieve subscription details.
146
147
 
147
148
  #### Parameters
148
149
 
149
- | Parameter | Type | Description |
150
- | ------ | ------ | ------ |
150
+ | Parameter | Type | Description |
151
+ | ---------------- | -------- | ------------------------ |
151
152
  | `subscriptionId` | `string` | Subscription identifier. |
152
153
 
153
154
  #### Returns
154
155
 
155
156
  `Promise`\<
156
- \| [`INormalizedSubscription`](Interface.INormalizedSubscription)
157
- \| `null`\>
157
+ \| [`INormalizedSubscription`](Interface.INormalizedSubscription)
158
+ \| `null`\>
158
159
 
159
160
  Normalized subscription or `null` if not found.
160
161