@breadstone/archipel-mcp 0.0.8 → 0.0.10

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 (569) hide show
  1. package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +19 -20
  2. package/data/packages/platform-analytics/api/Class.AnalyticsModule.md +2 -3
  3. package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +28 -29
  4. package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +28 -29
  5. package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +19 -20
  6. package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +28 -29
  7. package/data/packages/platform-analytics/api/Interface.IAnalyticsBreadcrumb.md +3 -4
  8. package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md +2 -3
  9. package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md +3 -4
  10. package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md +1 -2
  11. package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md +2 -3
  12. package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md +1 -2
  13. package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md +2 -3
  14. package/data/packages/platform-analytics/api/Variable.DD_ENV.md +1 -2
  15. package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md +1 -2
  16. package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md +2 -3
  17. package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md +1 -2
  18. package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md +1 -2
  19. package/data/packages/platform-analytics/api/index.md +25 -26
  20. package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +4 -5
  21. package/data/packages/platform-authentication/api/Class.AppleConnector.md +86 -0
  22. package/data/packages/platform-authentication/api/Class.AuthModule.md +8 -9
  23. package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +10 -11
  24. package/data/packages/platform-authentication/api/Class.AuthTokenService.md +5 -6
  25. package/data/packages/platform-authentication/api/Class.ChallengeService.md +32 -33
  26. package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +4 -5
  27. package/data/packages/platform-authentication/api/Class.GithubConnector.md +78 -0
  28. package/data/packages/platform-authentication/api/Class.GoogleConnector.md +84 -0
  29. package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +4 -5
  30. package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +15 -16
  31. package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +10 -11
  32. package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +4 -5
  33. package/data/packages/platform-authentication/api/Class.MfaService.md +65 -66
  34. package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +8 -9
  35. package/data/packages/platform-authentication/api/Class.MicrosoftConnector.md +84 -0
  36. package/data/packages/platform-authentication/api/Class.RolesGuard.md +5 -6
  37. package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +4 -5
  38. package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +25 -26
  39. package/data/packages/platform-authentication/api/Class.SessionResponse.md +12 -13
  40. package/data/packages/platform-authentication/api/Class.SessionService.md +33 -34
  41. package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +5 -6
  42. package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +2 -3
  43. package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +2 -3
  44. package/data/packages/platform-authentication/api/Class.TotpMfaChannel.md +144 -0
  45. package/data/packages/platform-authentication/api/Class.VerificationService.md +36 -37
  46. package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +16 -17
  47. package/data/packages/platform-authentication/api/Function.Token.md +0 -1
  48. package/data/packages/platform-authentication/api/Function.UseRoles.md +2 -3
  49. package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md +2 -3
  50. package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +54 -25
  51. package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +7 -8
  52. package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +5 -6
  53. package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +22 -23
  54. package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +0 -1
  55. package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +3 -4
  56. package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +9 -10
  57. package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +7 -8
  58. package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +14 -15
  59. package/data/packages/platform-authentication/api/Interface.ISignInResult.md +5 -6
  60. package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +3 -4
  61. package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +5 -6
  62. package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +4 -5
  63. package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +3 -4
  64. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +2 -3
  65. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +2 -3
  66. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +2 -3
  67. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +2 -3
  68. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_SCOPE.md +2 -3
  69. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +2 -3
  70. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +2 -3
  71. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +2 -3
  72. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +2 -3
  73. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_SCOPE.md +2 -3
  74. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +2 -3
  75. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +2 -3
  76. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +2 -3
  77. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_SCOPE.md +2 -3
  78. package/data/packages/platform-authentication/api/Variable.AUTH_JWT_EXPIRES_IN.md +2 -3
  79. package/data/packages/platform-authentication/api/Variable.AUTH_JWT_SECRET.md +2 -3
  80. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN.md +2 -3
  81. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +2 -3
  82. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +2 -3
  83. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ENCRYPTION_KEY.md +2 -3
  84. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ISSUER.md +14 -0
  85. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_MAX_ATTEMPTS.md +2 -3
  86. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +2 -3
  87. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +2 -3
  88. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +2 -3
  89. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +2 -3
  90. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +2 -3
  91. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +2 -3
  92. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +2 -3
  93. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_SCOPE.md +2 -3
  94. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +2 -3
  95. package/data/packages/platform-authentication/api/Variable.AUTH_VERIFY_JWT_EXPIRES_IN.md +2 -3
  96. package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +3 -4
  97. package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +3 -4
  98. package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +3 -4
  99. package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +3 -4
  100. package/data/packages/platform-authentication/api/Variable.ROLES_KEY.md +2 -3
  101. package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +2 -3
  102. package/data/packages/platform-authentication/api/Variable.SESSION_LIST_MAPPING_KEY.md +1 -2
  103. package/data/packages/platform-authentication/api/Variable.SESSION_MAPPING_KEY.md +1 -2
  104. package/data/packages/platform-authentication/api/Variable.TOTP_MFA_PROVIDERS.md +29 -0
  105. package/data/packages/platform-authentication/api/Variable.User.md +2 -3
  106. package/data/packages/platform-authentication/api/index.md +94 -92
  107. package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +16 -17
  108. package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +16 -17
  109. package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +5 -6
  110. package/data/packages/platform-blob-storage/api/Class.BlobModule.md +4 -5
  111. package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +12 -13
  112. package/data/packages/platform-blob-storage/api/Class.BlobService.md +45 -46
  113. package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +7 -8
  114. package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +18 -19
  115. package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +5 -6
  116. package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +5 -6
  117. package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +2 -3
  118. package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +5 -6
  119. package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +2 -3
  120. package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +3 -4
  121. package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +6 -7
  122. package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +8 -9
  123. package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +12 -13
  124. package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +14 -15
  125. package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +3 -4
  126. package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +8 -9
  127. package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +1 -2
  128. package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +5 -6
  129. package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +5 -6
  130. package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +5 -6
  131. package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +1 -2
  132. package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +0 -1
  133. package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +2 -3
  134. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +1 -2
  135. package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +1 -2
  136. package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +1 -2
  137. package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +9 -10
  138. package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +10 -11
  139. package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +1 -2
  140. package/data/packages/platform-blob-storage/api/index.md +41 -42
  141. package/data/packages/platform-caching/api/Class.MemoryLayeredCache.md +47 -48
  142. package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +24 -25
  143. package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +47 -48
  144. package/data/packages/platform-caching/api/Interface.ICacheMetricsRecorder.md +24 -25
  145. package/data/packages/platform-caching/api/Interface.ICacheStats.md +9 -10
  146. package/data/packages/platform-caching/api/Interface.ILayeredCache.md +42 -43
  147. package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +9 -10
  148. package/data/packages/platform-caching/api/Interface.IRedisLayeredCacheOptions.md +22 -23
  149. package/data/packages/platform-caching/api/index.md +12 -13
  150. package/data/packages/platform-core/api/Class.AppHealthIndicator.md +4 -5
  151. package/data/packages/platform-core/api/Class.BlobResourceStrategy.md +20 -21
  152. package/data/packages/platform-core/api/Class.BooleanUtils.md +12 -13
  153. package/data/packages/platform-core/api/Class.CUIDGenerator.md +17 -18
  154. package/data/packages/platform-core/api/Class.CasingInterceptor.md +10 -11
  155. package/data/packages/platform-core/api/Class.CatchUtils.md +15 -16
  156. package/data/packages/platform-core/api/Class.ConfigKeyNotFoundError.md +89 -0
  157. package/data/packages/platform-core/api/Class.ConfigModule.md +7 -8
  158. package/data/packages/platform-core/api/Class.ConfigRegistry.md +8 -9
  159. package/data/packages/platform-core/api/Class.ConfigService.md +30 -32
  160. package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +17 -18
  161. package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +4 -5
  162. package/data/packages/platform-core/api/Class.DateTimeUtils.md +12 -13
  163. package/data/packages/platform-core/api/Class.DeviceParserService.md +2 -3
  164. package/data/packages/platform-core/api/Class.EmbeddedResourceStrategy.md +22 -23
  165. package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +19 -20
  166. package/data/packages/platform-core/api/Class.ErrorTemplateService.md +19 -20
  167. package/data/packages/platform-core/api/Class.EventHub.md +25 -26
  168. package/data/packages/platform-core/api/Class.EventModule.md +0 -1
  169. package/data/packages/platform-core/api/Class.FileConfigStrategy.md +21 -22
  170. package/data/packages/platform-core/api/Class.FileResourceStrategy.md +19 -20
  171. package/data/packages/platform-core/api/Class.GUIDGenerator.md +7 -8
  172. package/data/packages/platform-core/api/Class.GlobalExceptionFilter.md +7 -8
  173. package/data/packages/platform-core/api/Class.HealthModule.md +2 -3
  174. package/data/packages/platform-core/api/Class.HealthOrchestrator.md +3 -4
  175. package/data/packages/platform-core/api/Class.HostModule.md +0 -2
  176. package/data/packages/platform-core/api/Class.HostService.md +21 -22
  177. package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md +8 -9
  178. package/data/packages/platform-core/api/Class.IdGeneratorBase.md +7 -8
  179. package/data/packages/platform-core/api/Class.IdentifierModule.md +3 -4
  180. package/data/packages/platform-core/api/Class.LimitRequestSizeMiddleware.md +8 -9
  181. package/data/packages/platform-core/api/Class.LocalizedTextRequest.md +1 -2
  182. package/data/packages/platform-core/api/Class.LocalizedTextResponse.md +1 -2
  183. package/data/packages/platform-core/api/Class.MappingBuilder.md +18 -19
  184. package/data/packages/platform-core/api/Class.MappingModule.md +2 -3
  185. package/data/packages/platform-core/api/Class.MappingNotRegisteredError.md +5 -6
  186. package/data/packages/platform-core/api/Class.MappingProfileBase.md +2 -3
  187. package/data/packages/platform-core/api/Class.MappingService.md +52 -53
  188. package/data/packages/platform-core/api/Class.NormalizedUtils.md +20 -21
  189. package/data/packages/platform-core/api/Class.PageableRequest.md +1 -2
  190. package/data/packages/platform-core/api/Class.PageableResponse.md +3 -4
  191. package/data/packages/platform-core/api/Class.ProblemDetailException.md +6 -7
  192. package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +11 -12
  193. package/data/packages/platform-core/api/Class.QuantityResponse.md +1 -2
  194. package/data/packages/platform-core/api/Class.ResourceManager.md +107 -108
  195. package/data/packages/platform-core/api/Class.ResourceModule.md +3 -4
  196. package/data/packages/platform-core/api/Class.ResponseReturn.md +102 -104
  197. package/data/packages/platform-core/api/Class.SseHub.md +23 -24
  198. package/data/packages/platform-core/api/Class.SseModule.md +3 -4
  199. package/data/packages/platform-core/api/Class.TimeStampResponse.md +1 -2
  200. package/data/packages/platform-core/api/Class.TypeMappingNotRegisteredError.md +5 -6
  201. package/data/packages/platform-core/api/Class.UUIDGenerator.md +7 -8
  202. package/data/packages/platform-core/api/Class.UserAvatarGeneratorService.md +4 -5
  203. package/data/packages/platform-core/api/Class.UserNameGeneratorService.md +4 -5
  204. package/data/packages/platform-core/api/Function.Public.md +0 -1
  205. package/data/packages/platform-core/api/Function.createConfigKey.md +7 -9
  206. package/data/packages/platform-core/api/Function.createEventKey.md +6 -7
  207. package/data/packages/platform-core/api/Function.createMappingKey.md +6 -7
  208. package/data/packages/platform-core/api/Function.env.md +4 -5
  209. package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +2 -3
  210. package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +4 -5
  211. package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md +1 -2
  212. package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md +5 -6
  213. package/data/packages/platform-core/api/Interface.IConfigKey.md +16 -17
  214. package/data/packages/platform-core/api/Interface.IConfigModuleOptions.md +3 -4
  215. package/data/packages/platform-core/api/Interface.IConfigRegistryEntry.md +6 -7
  216. package/data/packages/platform-core/api/Interface.IDeviceInfo.md +6 -7
  217. package/data/packages/platform-core/api/Interface.IErrorPageParams.md +11 -12
  218. package/data/packages/platform-core/api/Interface.IEventKey.md +7 -8
  219. package/data/packages/platform-core/api/Interface.IEventMap.md +0 -1
  220. package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md +5 -6
  221. package/data/packages/platform-core/api/Interface.IHealthCheckResult.md +3 -4
  222. package/data/packages/platform-core/api/Interface.IHealthIndicator.md +3 -4
  223. package/data/packages/platform-core/api/Interface.IHostContentParams.md +14 -15
  224. package/data/packages/platform-core/api/Interface.IIdGenerator.md +7 -8
  225. package/data/packages/platform-core/api/Interface.IMappingBuilder.md +17 -18
  226. package/data/packages/platform-core/api/Interface.IMappingKey.md +7 -8
  227. package/data/packages/platform-core/api/Interface.IMappingProfile.md +2 -3
  228. package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +8 -9
  229. package/data/packages/platform-core/api/Interface.IResourceMetadata.md +6 -7
  230. package/data/packages/platform-core/api/Interface.IResourceResult.md +1 -2
  231. package/data/packages/platform-core/api/Interface.IResourceStrategy.md +16 -17
  232. package/data/packages/platform-core/api/Interface.ISseEventData.md +3 -4
  233. package/data/packages/platform-core/api/Interface.ISseHub.md +16 -17
  234. package/data/packages/platform-core/api/Namespace.ISseEventData.md +2 -3
  235. package/data/packages/platform-core/api/TypeAlias.CamelCase.md +2 -3
  236. package/data/packages/platform-core/api/TypeAlias.ProblemDetail.md +5 -6
  237. package/data/packages/platform-core/api/TypeAlias.ProblemDetailTypeUrlResolver.md +4 -5
  238. package/data/packages/platform-core/api/TypeAlias.SetOptional.md +4 -5
  239. package/data/packages/platform-core/api/TypeAlias.StringValue.md +4 -2
  240. package/data/packages/platform-core/api/Variable.APP_NAME.md +14 -0
  241. package/data/packages/platform-core/api/Variable.APP_PORT.md +1 -2
  242. package/data/packages/platform-core/api/Variable.APP_URL.md +1 -2
  243. package/data/packages/platform-core/api/Variable.APP_VERSION.md +1 -2
  244. package/data/packages/platform-core/api/Variable.GIT_COMMIT.md +14 -0
  245. package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +1 -2
  246. package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +1 -2
  247. package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +2 -3
  248. package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +2 -3
  249. package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +2 -3
  250. package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +2 -3
  251. package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +2 -3
  252. package/data/packages/platform-core/api/Variable.IpAddress.md +6 -7
  253. package/data/packages/platform-core/api/Variable.Lang.md +5 -6
  254. package/data/packages/platform-core/api/Variable.NODE_ENV.md +2 -3
  255. package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +3 -4
  256. package/data/packages/platform-core/api/Variable.UserAgent.md +2 -3
  257. package/data/packages/platform-core/api/index.md +116 -114
  258. package/data/packages/platform-cryptography/api/Class.BcryptService.md +9 -10
  259. package/data/packages/platform-cryptography/api/Class.CryptoService.md +5 -6
  260. package/data/packages/platform-cryptography/api/Class.OtpService.md +12 -13
  261. package/data/packages/platform-cryptography/api/Interface.IOtpService.md +12 -13
  262. package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md +6 -7
  263. package/data/packages/platform-cryptography/api/Variable.OTP_SERVICE_TOKEN.md +2 -3
  264. package/data/packages/platform-cryptography/api/Variable.TOTP_EPOCH_TOLERANCE.md +8 -9
  265. package/data/packages/platform-cryptography/api/index.md +11 -12
  266. package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +6 -7
  267. package/data/packages/platform-database/api/Class.DatabaseModule.md +5 -6
  268. package/data/packages/platform-database/api/Class.DatabaseService.md +19 -20
  269. package/data/packages/platform-database/api/Class.PrismaService.md +7 -8
  270. package/data/packages/platform-database/api/Class.RepositoryBase.md +126 -127
  271. package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +5 -6
  272. package/data/packages/platform-database/api/Function.pageable.md +13 -10
  273. package/data/packages/platform-database/api/Function.paginator.md +2 -3
  274. package/data/packages/platform-database/api/Function.query.md +7 -8
  275. package/data/packages/platform-database/api/Function.skip.md +5 -6
  276. package/data/packages/platform-database/api/Function.transactionalQuery.md +6 -7
  277. package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +0 -1
  278. package/data/packages/platform-database/api/Interface.IPaginateOptions.md +1 -2
  279. package/data/packages/platform-database/api/Interface.IPaginatedResult.md +4 -5
  280. package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +7 -8
  281. package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +5 -6
  282. package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +2 -3
  283. package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +2 -3
  284. package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +7 -8
  285. package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +3 -4
  286. package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +3 -4
  287. package/data/packages/platform-database/api/index.md +27 -28
  288. package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +31 -33
  289. package/data/packages/platform-documents/api/Class.DocumentEngine.md +7 -8
  290. package/data/packages/platform-documents/api/Class.DocumentModule.md +2 -3
  291. package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +21 -22
  292. package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +5 -7
  293. package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +5 -6
  294. package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +8 -9
  295. package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +2 -3
  296. package/data/packages/platform-documents/api/Interface.IImagePayload.md +3 -4
  297. package/data/packages/platform-documents/api/Interface.IImageProcessor.md +18 -19
  298. package/data/packages/platform-documents/api/Interface.IRenderOptions.md +3 -4
  299. package/data/packages/platform-documents/api/Interface.IRenderResult.md +3 -4
  300. package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +1 -2
  301. package/data/packages/platform-documents/api/TypeAlias.EngineType.md +1 -2
  302. package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +1 -2
  303. package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +1 -2
  304. package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +1 -2
  305. package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +1 -2
  306. package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +1 -2
  307. package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +1 -2
  308. package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +1 -2
  309. package/data/packages/platform-documents/api/index.md +28 -29
  310. package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +20 -21
  311. package/data/packages/platform-esigning/api/Class.EsigningError.md +4 -5
  312. package/data/packages/platform-esigning/api/Class.EsigningModule.md +2 -3
  313. package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +9 -10
  314. package/data/packages/platform-esigning/api/Class.EsigningService.md +24 -25
  315. package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +24 -25
  316. package/data/packages/platform-esigning/api/Class.SigningProviderError.md +9 -10
  317. package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +3 -4
  318. package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +2 -3
  319. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +6 -7
  320. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +3 -4
  321. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +3 -4
  322. package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +2 -3
  323. package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +3 -4
  324. package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +5 -6
  325. package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +5 -6
  326. package/data/packages/platform-esigning/api/Interface.ISigner.md +5 -6
  327. package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +5 -6
  328. package/data/packages/platform-esigning/api/Interface.ISigningField.md +10 -11
  329. package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +10 -11
  330. package/data/packages/platform-esigning/api/Interface.ISigningSession.md +4 -5
  331. package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +1 -2
  332. package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +1 -2
  333. package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +1 -2
  334. package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +1 -2
  335. package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +1 -2
  336. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +1 -2
  337. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +1 -2
  338. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +2 -3
  339. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +1 -2
  340. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +1 -2
  341. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +1 -2
  342. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +1 -2
  343. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +2 -3
  344. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +1 -2
  345. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +1 -2
  346. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +1 -2
  347. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +1 -2
  348. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +1 -2
  349. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +2 -3
  350. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +1 -2
  351. package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +1 -2
  352. package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +1 -2
  353. package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +1 -2
  354. package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +1 -2
  355. package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +1 -2
  356. package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +2 -3
  357. package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +1 -2
  358. package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +1 -2
  359. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +1 -2
  360. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +1 -2
  361. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +2 -3
  362. package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +1 -2
  363. package/data/packages/platform-esigning/api/Variable.SignerRoles.md +12 -13
  364. package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +14 -15
  365. package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +20 -21
  366. package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +18 -19
  367. package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +20 -21
  368. package/data/packages/platform-esigning/api/index.md +65 -66
  369. package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistrarBase.md +8 -9
  370. package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +13 -14
  371. package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +1 -2
  372. package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +10 -11
  373. package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +2 -3
  374. package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +2 -3
  375. package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +2 -3
  376. package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +2 -3
  377. package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +2 -3
  378. package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +3 -4
  379. package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +3 -4
  380. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +9 -10
  381. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +9 -10
  382. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +5 -6
  383. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +13 -14
  384. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +5 -6
  385. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +5 -6
  386. package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +10 -11
  387. package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +4 -5
  388. package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +9 -10
  389. package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +7 -8
  390. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +5 -6
  391. package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +5 -6
  392. package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +3 -4
  393. package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +9 -10
  394. package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +3 -4
  395. package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +3 -4
  396. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +3 -4
  397. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +13 -14
  398. package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +3 -4
  399. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +8 -9
  400. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +5 -6
  401. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +6 -7
  402. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceConversationMessageRole.md +1 -3
  403. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +2 -3
  404. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +1 -2
  405. package/data/packages/platform-intelligence/api/Variable.IntelligenceConversationMessageRoles.md +7 -8
  406. package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +10 -11
  407. package/data/packages/platform-intelligence/api/index.md +46 -47
  408. package/data/packages/platform-logging/api/Class.LoggerModule.md +0 -1
  409. package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +1 -2
  410. package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +2 -3
  411. package/data/packages/platform-logging/api/index.md +7 -8
  412. package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +2 -3
  413. package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +11 -12
  414. package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +2 -3
  415. package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +13 -14
  416. package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +4 -5
  417. package/data/packages/platform-mailing/api/Class.MailModule.md +0 -1
  418. package/data/packages/platform-mailing/api/Class.MailService.md +31 -32
  419. package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +12 -13
  420. package/data/packages/platform-mailing/api/Class.MailVerificationService.md +18 -19
  421. package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +16 -17
  422. package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +16 -17
  423. package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +16 -17
  424. package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +16 -17
  425. package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +16 -17
  426. package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +2 -3
  427. package/data/packages/platform-mailing/api/Interface.IMailEvents.md +0 -1
  428. package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +1 -2
  429. package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +1 -2
  430. package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +1 -2
  431. package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +2 -3
  432. package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +1 -2
  433. package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +1 -2
  434. package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +1 -2
  435. package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +1 -2
  436. package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +1 -2
  437. package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +1 -2
  438. package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +1 -2
  439. package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +1 -2
  440. package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +1 -2
  441. package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +1 -2
  442. package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +1 -2
  443. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +1 -2
  444. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +1 -2
  445. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +1 -2
  446. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +1 -2
  447. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +1 -2
  448. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +1 -2
  449. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +1 -2
  450. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +1 -2
  451. package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +1 -2
  452. package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +2 -3
  453. package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +1 -2
  454. package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +2 -3
  455. package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +1 -2
  456. package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +2 -3
  457. package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +1 -2
  458. package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +2 -3
  459. package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +2 -3
  460. package/data/packages/platform-mailing/api/index.md +54 -55
  461. package/data/packages/platform-mcp/api/Class.McpDiscoveryService.md +8 -9
  462. package/data/packages/platform-mcp/api/Class.McpModule.md +8 -9
  463. package/data/packages/platform-mcp/api/Class.McpRegistryService.md +16 -17
  464. package/data/packages/platform-mcp/api/Class.McpServerService.md +19 -20
  465. package/data/packages/platform-mcp/api/Function.McpPrompt.md +2 -3
  466. package/data/packages/platform-mcp/api/Function.McpResource.md +2 -3
  467. package/data/packages/platform-mcp/api/Function.McpTool.md +2 -3
  468. package/data/packages/platform-mcp/api/Interface.IMcpHandlerMetadata.md +2 -3
  469. package/data/packages/platform-mcp/api/Interface.IMcpModuleAsyncOptions.md +8 -9
  470. package/data/packages/platform-mcp/api/Interface.IMcpModuleOptions.md +3 -4
  471. package/data/packages/platform-mcp/api/Interface.IMcpModuleOptionsFactory.md +3 -4
  472. package/data/packages/platform-mcp/api/Interface.IMcpPromptMetadata.md +3 -4
  473. package/data/packages/platform-mcp/api/Interface.IMcpResourceMetadata.md +4 -5
  474. package/data/packages/platform-mcp/api/Interface.IMcpToolMetadata.md +5 -6
  475. package/data/packages/platform-mcp/api/Interface.IRegisteredPrompt.md +3 -4
  476. package/data/packages/platform-mcp/api/Interface.IRegisteredResource.md +3 -4
  477. package/data/packages/platform-mcp/api/Interface.IRegisteredTool.md +3 -4
  478. package/data/packages/platform-mcp/api/Interface.ISseTransportOptions.md +0 -1
  479. package/data/packages/platform-mcp/api/Interface.IStreamableHttpTransportOptions.md +1 -2
  480. package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +1 -2
  481. package/data/packages/platform-mcp/api/index.md +26 -27
  482. package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +5 -6
  483. package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +5 -6
  484. package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +20 -21
  485. package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +2 -3
  486. package/data/packages/platform-openapi/api/Function.Api.md +13 -14
  487. package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +5 -6
  488. package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +0 -1
  489. package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +8 -7
  490. package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +5 -6
  491. package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +5 -6
  492. package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +1 -2
  493. package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +2 -3
  494. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +1 -2
  495. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +1 -2
  496. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +1 -2
  497. package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +2 -3
  498. package/data/packages/platform-openapi/api/index.md +24 -25
  499. package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +7 -8
  500. package/data/packages/platform-payments/api/Class.FeatureGuard.md +6 -7
  501. package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +7 -8
  502. package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +30 -31
  503. package/data/packages/platform-payments/api/Class.MollieClient.md +30 -31
  504. package/data/packages/platform-payments/api/Class.PaddleClient.md +30 -31
  505. package/data/packages/platform-payments/api/Class.PaymentClientPort.md +25 -26
  506. package/data/packages/platform-payments/api/Class.PaymentModule.md +2 -3
  507. package/data/packages/platform-payments/api/Class.StripeClient.md +30 -31
  508. package/data/packages/platform-payments/api/Function.RequiresFeature.md +2 -3
  509. package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +4 -5
  510. package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +5 -6
  511. package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +6 -7
  512. package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +8 -9
  513. package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +2 -3
  514. package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +3 -4
  515. package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +9 -10
  516. package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +2 -3
  517. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +1 -2
  518. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +2 -3
  519. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +1 -2
  520. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +1 -2
  521. package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +1 -2
  522. package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +2 -3
  523. package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +1 -2
  524. package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +1 -2
  525. package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +2 -3
  526. package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +1 -2
  527. package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +1 -2
  528. package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +1 -2
  529. package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +2 -3
  530. package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +1 -2
  531. package/data/packages/platform-payments/api/index.md +40 -41
  532. package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +3 -4
  533. package/data/packages/platform-reporting/api/Class.ReportingDatasetNotFoundError.md +3 -4
  534. package/data/packages/platform-reporting/api/Class.ReportingFacade.md +8 -9
  535. package/data/packages/platform-reporting/api/Class.ReportingModule.md +0 -1
  536. package/data/packages/platform-reporting/api/Interface.IReportingContributor.md +4 -5
  537. package/data/packages/platform-reporting/api/Interface.IReportingDataset.md +5 -6
  538. package/data/packages/platform-reporting/api/Interface.IReportingDatasetField.md +4 -5
  539. package/data/packages/platform-reporting/api/Interface.IReportingQuery.md +4 -5
  540. package/data/packages/platform-reporting/api/Interface.IReportingQueryFilter.md +2 -3
  541. package/data/packages/platform-reporting/api/Interface.IReportingQueryResult.md +4 -5
  542. package/data/packages/platform-reporting/api/Interface.IReportingQuerySort.md +1 -2
  543. package/data/packages/platform-reporting/api/TypeAlias.ReportingFieldType.md +1 -2
  544. package/data/packages/platform-reporting/api/TypeAlias.ReportingFilterOperator.md +1 -2
  545. package/data/packages/platform-reporting/api/TypeAlias.ReportingQueryResultRow.md +0 -1
  546. package/data/packages/platform-reporting/api/Variable.ReportingFieldTypes.md +12 -13
  547. package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +10 -11
  548. package/data/packages/platform-reporting/api/index.md +23 -24
  549. package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +22 -23
  550. package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +26 -27
  551. package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +23 -24
  552. package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +35 -36
  553. package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +2 -3
  554. package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +4 -5
  555. package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +22 -23
  556. package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +2 -3
  557. package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +8 -9
  558. package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +2 -3
  559. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +1 -2
  560. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +1 -2
  561. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +1 -2
  562. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md +1 -2
  563. package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +0 -1
  564. package/data/packages/platform-telemetry/api/index.md +20 -21
  565. package/package.json +1 -1
  566. package/data/packages/platform-authentication/api/Class.AppleStrategy.md +0 -81
  567. package/data/packages/platform-authentication/api/Class.GithubStrategy.md +0 -73
  568. package/data/packages/platform-authentication/api/Class.GoogleStrategy.md +0 -79
  569. package/data/packages/platform-authentication/api/Class.MicrosoftStrategy.md +0 -79
@@ -3,8 +3,7 @@ title: 'Variable: STRIPE\_WEBHOOK\_SECRET'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
- # Variable: STRIPE_WEBHOOK_SECRET
6
+ # Variable: STRIPE\_WEBHOOK\_SECRET
8
7
 
9
8
  ```ts
10
9
  const STRIPE_WEBHOOK_SECRET: IConfigKey<string>;
@@ -3,62 +3,61 @@ title: '@breadstone/archipel-platform-payments'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # @breadstone/archipel-platform-payments
8
7
 
9
8
  ## Classes
10
9
 
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. |
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. |
22
21
 
23
22
  ## Interfaces
24
23
 
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`. |
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`. |
33
32
 
34
33
  ## Type Aliases
35
34
 
36
- | Type Alias | Description |
37
- | -------------------------------------------------- | -------------------------------------- |
35
+ | Type Alias | Description |
36
+ | ------ | ------ |
38
37
  | [SubscriptionStatus](TypeAlias.SubscriptionStatus) | Normalized subscription status values. |
39
38
 
40
39
  ## Variables
41
40
 
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. |
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. |
59
58
 
60
59
  ## Functions
61
60
 
62
- | Function | Description |
63
- | ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
61
+ | Function | Description |
62
+ | ------ | ------ |
64
63
  | [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,7 +3,6 @@ title: 'Class: ReportingContributorRegistry'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Class: ReportingContributorRegistry
8
7
 
9
8
  Defined in: [core/ReportingContributorRegistry.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/core/ReportingContributorRegistry.ts#L12)
@@ -36,7 +35,7 @@ Defined in: [core/ReportingContributorRegistry.ts:31](https://github.com/RueDeRe
36
35
 
37
36
  readonly [`IReportingContributor`](Interface.IReportingContributor)[]
38
37
 
39
- ---
38
+ ***
40
39
 
41
40
  ### register()
42
41
 
@@ -48,8 +47,8 @@ Defined in: [core/ReportingContributorRegistry.ts:23](https://github.com/RueDeRe
48
47
 
49
48
  #### Parameters
50
49
 
51
- | Parameter | Type |
52
- | ------------- | ---------------------------------------------------------- |
50
+ | Parameter | Type |
51
+ | ------ | ------ |
53
52
  | `contributor` | [`IReportingContributor`](Interface.IReportingContributor) |
54
53
 
55
54
  #### Returns
@@ -3,7 +3,6 @@ title: 'Class: ReportingDatasetNotFoundError'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Class: ReportingDatasetNotFoundError
8
7
 
9
8
  Defined in: [models/errors/ReportingDatasetNotFoundError.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/errors/ReportingDatasetNotFoundError.ts#L6)
@@ -26,8 +25,8 @@ Defined in: [models/errors/ReportingDatasetNotFoundError.ts:10](https://github.c
26
25
 
27
26
  #### Parameters
28
27
 
29
- | Parameter | Type |
30
- | ----------- | -------- |
28
+ | Parameter | Type |
29
+ | ------ | ------ |
31
30
  | `datasetId` | `string` |
32
31
 
33
32
  #### Returns
@@ -37,5 +36,5 @@ Defined in: [models/errors/ReportingDatasetNotFoundError.ts:10](https://github.c
37
36
  #### Overrides
38
37
 
39
38
  ```ts
40
- Error.constructor;
39
+ Error.constructor
41
40
  ```
@@ -3,7 +3,6 @@ title: 'Class: ReportingFacade'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Class: ReportingFacade
8
7
 
9
8
  Defined in: [core/ReportingFacade.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/core/ReportingFacade.ts#L19)
@@ -22,8 +21,8 @@ Defined in: [core/ReportingFacade.ts:31](https://github.com/RueDeRennes/archipel
22
21
 
23
22
  #### Parameters
24
23
 
25
- | Parameter | Type |
26
- | ---------- | -------------------------------------------------------------------- |
24
+ | Parameter | Type |
25
+ | ------ | ------ |
27
26
  | `registry` | [`ReportingContributorRegistry`](Class.ReportingContributorRegistry) |
28
27
 
29
28
  #### Returns
@@ -42,15 +41,15 @@ Defined in: [core/ReportingFacade.ts:52](https://github.com/RueDeRennes/archipel
42
41
 
43
42
  #### Parameters
44
43
 
45
- | Parameter | Type |
46
- | --------- | ---------------------------------------------- |
44
+ | Parameter | Type |
45
+ | ------ | ------ |
47
46
  | `request` | [`IReportingQuery`](Interface.IReportingQuery) |
48
47
 
49
48
  #### Returns
50
49
 
51
50
  `Promise`\<[`IReportingQueryResult`](Interface.IReportingQueryResult)\>
52
51
 
53
- ---
52
+ ***
54
53
 
55
54
  ### getCatalog()
56
55
 
@@ -64,7 +63,7 @@ Defined in: [core/ReportingFacade.ts:39](https://github.com/RueDeRennes/archipel
64
63
 
65
64
  `Promise`\<readonly [`IReportingDataset`](Interface.IReportingDataset)[]\>
66
65
 
67
- ---
66
+ ***
68
67
 
69
68
  ### getDataset()
70
69
 
@@ -76,8 +75,8 @@ Defined in: [core/ReportingFacade.ts:47](https://github.com/RueDeRennes/archipel
76
75
 
77
76
  #### Parameters
78
77
 
79
- | Parameter | Type |
80
- | ----------- | -------- |
78
+ | Parameter | Type |
79
+ | ------ | ------ |
81
80
  | `datasetId` | `string` |
82
81
 
83
82
  #### Returns
@@ -3,7 +3,6 @@ title: 'Class: ReportingModule'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Class: ReportingModule
8
7
 
9
8
  Defined in: [ReportingModule.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/ReportingModule.ts#L25)
@@ -3,7 +3,6 @@ title: 'Interface: IReportingContributor'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Interface: IReportingContributor
8
7
 
9
8
  Defined in: [core/ReportingContributor.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/core/ReportingContributor.ts#L12)
@@ -36,16 +35,16 @@ Executes the dataset query defined by the given request.
36
35
 
37
36
  #### Parameters
38
37
 
39
- | Parameter | Type |
40
- | ---------- | -------------------------------------------------- |
38
+ | Parameter | Type |
39
+ | ------ | ------ |
41
40
  | `_dataset` | [`IReportingDataset`](Interface.IReportingDataset) |
42
- | `_request` | [`IReportingQuery`](Interface.IReportingQuery) |
41
+ | `_request` | [`IReportingQuery`](Interface.IReportingQuery) |
43
42
 
44
43
  #### Returns
45
44
 
46
45
  `Promise`\<[`IReportingQueryResult`](Interface.IReportingQueryResult)\>
47
46
 
48
- ---
47
+ ***
49
48
 
50
49
  ### listDatasets()
51
50
 
@@ -3,7 +3,6 @@ title: 'Interface: IReportingDataset'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Interface: IReportingDataset
8
7
 
9
8
  Defined in: [models/ReportingDataset.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDataset.ts#L12)
@@ -22,7 +21,7 @@ Defined in: [models/ReportingDataset.ts:17](https://github.com/RueDeRennes/archi
22
21
 
23
22
  Fully qualified dataset identifier (`<feature>.<dataset>`).
24
23
 
25
- ---
24
+ ***
26
25
 
27
26
  ### datasetKey
28
27
 
@@ -34,7 +33,7 @@ Defined in: [models/ReportingDataset.ts:27](https://github.com/RueDeRennes/archi
34
33
 
35
34
  Dataset key within the feature namespace.
36
35
 
37
- ---
36
+ ***
38
37
 
39
38
  ### description?
40
39
 
@@ -46,7 +45,7 @@ Defined in: [models/ReportingDataset.ts:37](https://github.com/RueDeRennes/archi
46
45
 
47
46
  Optional dataset description presented to consumers.
48
47
 
49
- ---
48
+ ***
50
49
 
51
50
  ### featureKey
52
51
 
@@ -58,7 +57,7 @@ Defined in: [models/ReportingDataset.ts:22](https://github.com/RueDeRennes/archi
58
57
 
59
58
  Feature namespace owning the dataset.
60
59
 
61
- ---
60
+ ***
62
61
 
63
62
  ### fields
64
63
 
@@ -70,7 +69,7 @@ Defined in: [models/ReportingDataset.ts:42](https://github.com/RueDeRennes/archi
70
69
 
71
70
  Fields exposed by the dataset.
72
71
 
73
- ---
72
+ ***
74
73
 
75
74
  ### name
76
75
 
@@ -3,7 +3,6 @@ title: 'Interface: IReportingDatasetField'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Interface: IReportingDatasetField
8
7
 
9
8
  Defined in: [models/ReportingDatasetField.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L25)
@@ -22,7 +21,7 @@ Defined in: [models/ReportingDatasetField.ts:50](https://github.com/RueDeRennes/
22
21
 
23
22
  Optional documentation describing the semantic meaning of the field.
24
23
 
25
- ---
24
+ ***
26
25
 
27
26
  ### fieldId
28
27
 
@@ -34,7 +33,7 @@ Defined in: [models/ReportingDatasetField.ts:30](https://github.com/RueDeRennes/
34
33
 
35
34
  Unique identifier of the field within the dataset.
36
35
 
37
- ---
36
+ ***
38
37
 
39
38
  ### isNullable
40
39
 
@@ -46,7 +45,7 @@ Defined in: [models/ReportingDatasetField.ts:45](https://github.com/RueDeRennes/
46
45
 
47
46
  Indicates whether the field can contain null values.
48
47
 
49
- ---
48
+ ***
50
49
 
51
50
  ### label
52
51
 
@@ -58,7 +57,7 @@ Defined in: [models/ReportingDatasetField.ts:35](https://github.com/RueDeRennes/
58
57
 
59
58
  Human readable name of the field.
60
59
 
61
- ---
60
+ ***
62
61
 
63
62
  ### type
64
63
 
@@ -3,7 +3,6 @@ title: 'Interface: IReportingQuery'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Interface: IReportingQuery
8
7
 
9
8
  Defined in: [models/ReportingQuery.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L45)
@@ -20,7 +19,7 @@ readonly datasetId: string;
20
19
 
21
20
  Defined in: [models/ReportingQuery.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L46)
22
21
 
23
- ---
22
+ ***
24
23
 
25
24
  ### filters?
26
25
 
@@ -30,7 +29,7 @@ readonly optional filters?: readonly IReportingQueryFilter[];
30
29
 
31
30
  Defined in: [models/ReportingQuery.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L47)
32
31
 
33
- ---
32
+ ***
34
33
 
35
34
  ### limit?
36
35
 
@@ -40,7 +39,7 @@ readonly optional limit?: number;
40
39
 
41
40
  Defined in: [models/ReportingQuery.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L49)
42
41
 
43
- ---
42
+ ***
44
43
 
45
44
  ### offset?
46
45
 
@@ -50,7 +49,7 @@ readonly optional offset?: number;
50
49
 
51
50
  Defined in: [models/ReportingQuery.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L50)
52
51
 
53
- ---
52
+ ***
54
53
 
55
54
  ### sorts?
56
55
 
@@ -3,7 +3,6 @@ title: 'Interface: IReportingQueryFilter'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Interface: IReportingQueryFilter
8
7
 
9
8
  Defined in: [models/ReportingQuery.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L24)
@@ -20,7 +19,7 @@ readonly fieldId: string;
20
19
 
21
20
  Defined in: [models/ReportingQuery.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L25)
22
21
 
23
- ---
22
+ ***
24
23
 
25
24
  ### operator
26
25
 
@@ -30,7 +29,7 @@ readonly operator: ReportingFilterOperator;
30
29
 
31
30
  Defined in: [models/ReportingQuery.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L26)
32
31
 
33
- ---
32
+ ***
34
33
 
35
34
  ### value
36
35
 
@@ -3,7 +3,6 @@ title: 'Interface: IReportingQueryResult'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Interface: IReportingQueryResult
8
7
 
9
8
  Defined in: [models/ReportingQueryResult.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQueryResult.ts#L19)
@@ -20,7 +19,7 @@ readonly datasetId: string;
20
19
 
21
20
  Defined in: [models/ReportingQueryResult.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQueryResult.ts#L20)
22
21
 
23
- ---
22
+ ***
24
23
 
25
24
  ### fields
26
25
 
@@ -30,7 +29,7 @@ readonly fields: readonly IReportingDatasetField[];
30
29
 
31
30
  Defined in: [models/ReportingQueryResult.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQueryResult.ts#L21)
32
31
 
33
- ---
32
+ ***
34
33
 
35
34
  ### generatedAt
36
35
 
@@ -40,7 +39,7 @@ readonly generatedAt: Date;
40
39
 
41
40
  Defined in: [models/ReportingQueryResult.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQueryResult.ts#L24)
42
41
 
43
- ---
42
+ ***
44
43
 
45
44
  ### rows
46
45
 
@@ -50,7 +49,7 @@ readonly rows: readonly ReportingQueryResultRow[];
50
49
 
51
50
  Defined in: [models/ReportingQueryResult.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQueryResult.ts#L22)
52
51
 
53
- ---
52
+ ***
54
53
 
55
54
  ### totalCount
56
55
 
@@ -3,7 +3,6 @@ title: 'Interface: IReportingQuerySort'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Interface: IReportingQuerySort
8
7
 
9
8
  Defined in: [models/ReportingQuery.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L35)
@@ -20,7 +19,7 @@ readonly direction: "asc" | "desc";
20
19
 
21
20
  Defined in: [models/ReportingQuery.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L37)
22
21
 
23
- ---
22
+ ***
24
23
 
25
24
  ### fieldId
26
25
 
@@ -3,11 +3,10 @@ title: 'Type Alias: ReportingFieldType'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Type Alias: ReportingFieldType
8
7
 
9
8
  ```ts
10
- type ReportingFieldType = (typeof ReportingFieldTypes)[keyof typeof ReportingFieldTypes];
9
+ type ReportingFieldType = typeof ReportingFieldTypes[keyof typeof ReportingFieldTypes];
11
10
  ```
12
11
 
13
12
  Defined in: [models/ReportingDatasetField.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L18)
@@ -3,11 +3,10 @@ title: 'Type Alias: ReportingFilterOperator'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Type Alias: ReportingFilterOperator
8
7
 
9
8
  ```ts
10
- type ReportingFilterOperator = (typeof ReportingFilterOperators)[keyof typeof ReportingFilterOperators];
9
+ type ReportingFilterOperator = typeof ReportingFilterOperators[keyof typeof ReportingFilterOperators];
11
10
  ```
12
11
 
13
12
  Defined in: [models/ReportingQuery.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L17)
@@ -3,7 +3,6 @@ title: 'Type Alias: ReportingQueryResultRow'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Type Alias: ReportingQueryResultRow
8
7
 
9
8
  ```ts
@@ -3,16 +3,15 @@ title: 'Variable: ReportingFieldTypes'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Variable: ReportingFieldTypes
8
7
 
9
8
  ```ts
10
9
  const ReportingFieldTypes: {
11
- Boolean: 'boolean';
12
- DateTime: 'datetime';
13
- Json: 'json';
14
- Number: 'number';
15
- String: 'string';
10
+ Boolean: "boolean";
11
+ DateTime: "datetime";
12
+ Json: "json";
13
+ Number: "number";
14
+ String: "string";
16
15
  };
17
16
  ```
18
17
 
@@ -22,10 +21,10 @@ Enumerates the supported field data types for reporting datasets.
22
21
 
23
22
  ## Type Declaration
24
23
 
25
- | Name | Type | Default value | Defined in |
26
- | ----------------------------------------- | ------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
27
- | <a id="property-boolean"></a> `Boolean` | `"boolean"` | `'boolean'` | [models/ReportingDatasetField.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L11) |
28
- | <a id="property-datetime"></a> `DateTime` | `"datetime"` | `'datetime'` | [models/ReportingDatasetField.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L12) |
29
- | <a id="property-json"></a> `Json` | `"json"` | `'json'` | [models/ReportingDatasetField.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L13) |
30
- | <a id="property-number"></a> `Number` | `"number"` | `'number'` | [models/ReportingDatasetField.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L14) |
31
- | <a id="property-string"></a> `String` | `"string"` | `'string'` | [models/ReportingDatasetField.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L15) |
24
+ | Name | Type | Default value | Defined in |
25
+ | ------ | ------ | ------ | ------ |
26
+ | <a id="property-boolean"></a> `Boolean` | `"boolean"` | `'boolean'` | [models/ReportingDatasetField.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L11) |
27
+ | <a id="property-datetime"></a> `DateTime` | `"datetime"` | `'datetime'` | [models/ReportingDatasetField.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L12) |
28
+ | <a id="property-json"></a> `Json` | `"json"` | `'json'` | [models/ReportingDatasetField.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L13) |
29
+ | <a id="property-number"></a> `Number` | `"number"` | `'number'` | [models/ReportingDatasetField.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L14) |
30
+ | <a id="property-string"></a> `String` | `"string"` | `'string'` | [models/ReportingDatasetField.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L15) |
@@ -3,15 +3,14 @@ title: 'Variable: ReportingFilterOperators'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Variable: ReportingFilterOperators
8
7
 
9
8
  ```ts
10
9
  const ReportingFilterOperators: {
11
- Equals: 'equals';
12
- GreaterThanOrEqual: 'gte';
13
- In: 'in';
14
- LessThanOrEqual: 'lte';
10
+ Equals: "equals";
11
+ GreaterThanOrEqual: "gte";
12
+ In: "in";
13
+ LessThanOrEqual: "lte";
15
14
  };
16
15
  ```
17
16
 
@@ -21,9 +20,9 @@ Enumerates supported filter operators for dataset queries.
21
20
 
22
21
  ## Type Declaration
23
22
 
24
- | Name | Type | Default value | Defined in |
25
- | ------------------------------------------------------------- | ---------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-equals"></a> `Equals` | `"equals"` | `'equals'` | [models/ReportingQuery.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L11) |
27
- | <a id="property-greaterthanorequal"></a> `GreaterThanOrEqual` | `"gte"` | `'gte'` | [models/ReportingQuery.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L12) |
28
- | <a id="property-in"></a> `In` | `"in"` | `'in'` | [models/ReportingQuery.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L13) |
29
- | <a id="property-lessthanorequal"></a> `LessThanOrEqual` | `"lte"` | `'lte'` | [models/ReportingQuery.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L14) |
23
+ | Name | Type | Default value | Defined in |
24
+ | ------ | ------ | ------ | ------ |
25
+ | <a id="property-equals"></a> `Equals` | `"equals"` | `'equals'` | [models/ReportingQuery.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L11) |
26
+ | <a id="property-greaterthanorequal"></a> `GreaterThanOrEqual` | `"gte"` | `'gte'` | [models/ReportingQuery.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L12) |
27
+ | <a id="property-in"></a> `In` | `"in"` | `'in'` | [models/ReportingQuery.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L13) |
28
+ | <a id="property-lessthanorequal"></a> `LessThanOrEqual` | `"lte"` | `'lte'` | [models/ReportingQuery.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L14) |