@breadstone/archipel-mcp 0.0.1 → 0.0.2

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 +7 -6
  2. package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +141 -0
  3. package/data/packages/platform-analytics/api/Class.AnalyticsModule.md +47 -0
  4. package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +169 -0
  5. package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +169 -0
  6. package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +161 -0
  7. package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +169 -0
  8. package/data/packages/platform-analytics/api/Interface.IAnalyticsBreadcrumb.md +58 -0
  9. package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md +47 -0
  10. package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md +58 -0
  11. package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md +14 -0
  12. package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md +14 -0
  13. package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md +14 -0
  14. package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md +14 -0
  15. package/data/packages/platform-analytics/api/Variable.DD_ENV.md +14 -0
  16. package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md +14 -0
  17. package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md +14 -0
  18. package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md +14 -0
  19. package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md +14 -0
  20. package/data/packages/platform-analytics/api/index.md +44 -0
  21. package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +4 -9
  22. package/data/packages/platform-authentication/api/Class.AppleStrategy.md +80 -0
  23. package/data/packages/platform-authentication/api/Class.AuthModule.md +8 -13
  24. package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +10 -15
  25. package/data/packages/platform-authentication/api/Class.AuthTokenService.md +5 -10
  26. package/data/packages/platform-authentication/api/Class.ChallengeService.md +26 -31
  27. package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +4 -9
  28. package/data/packages/platform-authentication/api/Class.GithubStrategy.md +72 -0
  29. package/data/packages/platform-authentication/api/Class.GoogleStrategy.md +78 -0
  30. package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +4 -9
  31. package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +33 -13
  32. package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +10 -15
  33. package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +4 -9
  34. package/data/packages/platform-authentication/api/Class.MfaService.md +54 -59
  35. package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +8 -13
  36. package/data/packages/platform-authentication/api/Class.MicrosoftStrategy.md +78 -0
  37. package/data/packages/platform-authentication/api/Class.RolesGuard.md +5 -10
  38. package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +4 -9
  39. package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +25 -30
  40. package/data/packages/platform-authentication/api/Class.SessionResponse.md +12 -17
  41. package/data/packages/platform-authentication/api/Class.SessionService.md +33 -38
  42. package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +5 -10
  43. package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +2 -7
  44. package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +2 -7
  45. package/data/packages/platform-authentication/api/Class.VerificationService.md +29 -34
  46. package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +16 -21
  47. package/data/packages/platform-authentication/api/Function.Token.md +18 -0
  48. package/data/packages/platform-authentication/api/Function.UseRoles.md +24 -0
  49. package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md +22 -0
  50. package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +42 -18
  51. package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +7 -12
  52. package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +5 -10
  53. package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +10 -15
  54. package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +0 -5
  55. package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +3 -8
  56. package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +9 -14
  57. package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +7 -12
  58. package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +14 -19
  59. package/data/packages/platform-authentication/api/Interface.ISignInResult.md +5 -10
  60. package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +3 -8
  61. package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +5 -10
  62. package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +4 -9
  63. package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +14 -0
  64. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +14 -0
  65. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +14 -0
  66. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +14 -0
  67. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +14 -0
  68. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +14 -0
  69. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +14 -0
  70. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +14 -0
  71. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +14 -0
  72. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +14 -0
  73. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +14 -0
  74. package/data/packages/platform-authentication/api/Variable.AUTH_JWT_EXPIRES_IN.md +14 -0
  75. package/data/packages/platform-authentication/api/Variable.AUTH_JWT_SECRET.md +14 -0
  76. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN.md +14 -0
  77. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +14 -0
  78. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +14 -0
  79. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ENCRYPTION_KEY.md +14 -0
  80. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_MAX_ATTEMPTS.md +14 -0
  81. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +14 -0
  82. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +14 -0
  83. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +14 -0
  84. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +14 -0
  85. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +14 -0
  86. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +14 -0
  87. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +14 -0
  88. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +14 -0
  89. package/data/packages/platform-authentication/api/Variable.AUTH_VERIFY_JWT_EXPIRES_IN.md +14 -0
  90. package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +14 -0
  91. package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +14 -0
  92. package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +14 -0
  93. package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +14 -0
  94. package/data/packages/platform-authentication/api/Variable.ROLES_KEY.md +14 -0
  95. package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +14 -0
  96. package/data/packages/platform-authentication/api/Variable.SESSION_LIST_MAPPING_KEY.md +14 -0
  97. package/data/packages/platform-authentication/api/Variable.SESSION_MAPPING_KEY.md +14 -0
  98. package/data/packages/platform-authentication/api/Variable.User.md +24 -0
  99. package/data/packages/platform-authentication/api/index.md +86 -490
  100. package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +196 -0
  101. package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +196 -0
  102. package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +5 -10
  103. package/data/packages/platform-blob-storage/api/Class.BlobModule.md +4 -9
  104. package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +12 -17
  105. package/data/packages/platform-blob-storage/api/Class.BlobService.md +45 -50
  106. package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +7 -12
  107. package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +18 -23
  108. package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +28 -0
  109. package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +68 -0
  110. package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +38 -0
  111. package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +28 -0
  112. package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +6 -11
  113. package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +8 -13
  114. package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +12 -17
  115. package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +8 -13
  116. package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +26 -31
  117. package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +21 -26
  118. package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +8 -13
  119. package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +18 -23
  120. package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +4 -9
  121. package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +5 -10
  122. package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +5 -10
  123. package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +5 -10
  124. package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +2 -7
  125. package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +1 -6
  126. package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +6 -7
  127. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +12 -0
  128. package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +12 -0
  129. package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +12 -0
  130. package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +26 -0
  131. package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +26 -0
  132. package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +12 -0
  133. package/data/packages/platform-blob-storage/api/index.md +41 -93
  134. package/data/packages/platform-core/api/Class.AppHealthIndicator.md +2 -3
  135. package/data/packages/platform-core/api/Class.BcryptService.md +7 -8
  136. package/data/packages/platform-core/api/Class.BlobResourceStrategy.md +20 -21
  137. package/data/packages/platform-core/api/Class.BooleanUtils.md +12 -13
  138. package/data/packages/platform-core/api/Class.CUIDGenerator.md +17 -18
  139. package/data/packages/platform-core/api/Class.CasingInterceptor.md +12 -13
  140. package/data/packages/platform-core/api/Class.CatchUtils.md +15 -16
  141. package/data/packages/platform-core/api/Class.ConfigModule.md +7 -8
  142. package/data/packages/platform-core/api/Class.ConfigRegistry.md +8 -9
  143. package/data/packages/platform-core/api/Class.ConfigService.md +26 -27
  144. package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +33 -18
  145. package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +6 -7
  146. package/data/packages/platform-core/api/Class.CryptoService.md +3 -4
  147. package/data/packages/platform-core/api/Class.DateTimeUtils.md +12 -13
  148. package/data/packages/platform-core/api/Class.DeviceParserService.md +2 -3
  149. package/data/packages/platform-core/api/Class.EmbeddedResourceStrategy.md +22 -23
  150. package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +18 -21
  151. package/data/packages/platform-core/api/Class.ErrorTemplateService.md +15 -16
  152. package/data/packages/platform-core/api/Class.EventHub.md +25 -26
  153. package/data/packages/platform-core/api/Class.EventModule.md +0 -1
  154. package/data/packages/platform-core/api/Class.FileConfigStrategy.md +20 -23
  155. package/data/packages/platform-core/api/Class.FileResourceStrategy.md +19 -20
  156. package/data/packages/platform-core/api/Class.GUIDGenerator.md +7 -8
  157. package/data/packages/platform-core/api/Class.GlobalExceptionFilter.md +7 -8
  158. package/data/packages/platform-core/api/Class.HealthModule.md +2 -3
  159. package/data/packages/platform-core/api/Class.HealthOrchestrator.md +3 -4
  160. package/data/packages/platform-core/api/Class.HostModule.md +0 -2
  161. package/data/packages/platform-core/api/Class.HostService.md +13 -14
  162. package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md +8 -9
  163. package/data/packages/platform-core/api/Class.IdGeneratorBase.md +7 -8
  164. package/data/packages/platform-core/api/Class.IdentifierModule.md +5 -6
  165. package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistrarBase.md +56 -3
  166. package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistry.md +10 -11
  167. package/data/packages/platform-core/api/Class.IntelligenceModule.md +0 -1
  168. package/data/packages/platform-core/api/Class.IntelligenceTextGenerator.md +6 -7
  169. package/data/packages/platform-core/api/Class.LimitRequestSizeMiddleware.md +8 -9
  170. package/data/packages/platform-core/api/Class.LocalizedTextRequest.md +1 -2
  171. package/data/packages/platform-core/api/Class.LocalizedTextResponse.md +1 -2
  172. package/data/packages/platform-core/api/Class.MappingBuilder.md +18 -19
  173. package/data/packages/platform-core/api/Class.MappingModule.md +2 -3
  174. package/data/packages/platform-core/api/Class.MappingNotRegisteredError.md +5 -6
  175. package/data/packages/platform-core/api/Class.MappingProfileBase.md +2 -3
  176. package/data/packages/platform-core/api/Class.MappingService.md +52 -53
  177. package/data/packages/platform-core/api/Class.MemoryLayeredCache.md +37 -38
  178. package/data/packages/platform-core/api/Class.NoopCacheMetricsRecorder.md +19 -20
  179. package/data/packages/platform-core/api/Class.NormalizedUtils.md +20 -21
  180. package/data/packages/platform-core/api/Class.OtpService.md +8 -9
  181. package/data/packages/platform-core/api/Class.PageableRequest.md +1 -2
  182. package/data/packages/platform-core/api/Class.PageableResponse.md +3 -4
  183. package/data/packages/platform-core/api/Class.ProblemDetailException.md +6 -7
  184. package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +21 -12
  185. package/data/packages/platform-core/api/Class.QuantityResponse.md +1 -2
  186. package/data/packages/platform-core/api/Class.RedisLayeredCache.md +39 -40
  187. package/data/packages/platform-core/api/Class.ResourceManager.md +88 -89
  188. package/data/packages/platform-core/api/Class.ResourceModule.md +3 -4
  189. package/data/packages/platform-core/api/Class.ResponseReturn.md +123 -125
  190. package/data/packages/platform-core/api/Class.SseHub.md +23 -24
  191. package/data/packages/platform-core/api/Class.SseModule.md +3 -4
  192. package/data/packages/platform-core/api/Class.TimeStampResponse.md +1 -2
  193. package/data/packages/platform-core/api/Class.TypeMappingNotRegisteredError.md +5 -6
  194. package/data/packages/platform-core/api/Class.UUIDGenerator.md +7 -8
  195. package/data/packages/platform-core/api/Class.UserAvatarGeneratorService.md +4 -5
  196. package/data/packages/platform-core/api/Class.UserNameGeneratorService.md +4 -5
  197. package/data/packages/platform-core/api/Function.Public.md +18 -0
  198. package/data/packages/platform-core/api/Function.createConfigKey.md +58 -0
  199. package/data/packages/platform-core/api/Function.createEventKey.md +33 -0
  200. package/data/packages/platform-core/api/Function.createMappingKey.md +39 -0
  201. package/data/packages/platform-core/api/Function.env.md +28 -0
  202. package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +26 -0
  203. package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +27 -0
  204. package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md +1 -2
  205. package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md +5 -6
  206. package/data/packages/platform-core/api/Interface.ICacheMetricsRecorder.md +19 -20
  207. package/data/packages/platform-core/api/Interface.ICacheStats.md +4 -5
  208. package/data/packages/platform-core/api/Interface.IConfigKey.md +16 -17
  209. package/data/packages/platform-core/api/Interface.IConfigModuleOptions.md +3 -4
  210. package/data/packages/platform-core/api/Interface.IConfigRegistryEntry.md +6 -7
  211. package/data/packages/platform-core/api/Interface.IDeviceInfo.md +6 -7
  212. package/data/packages/platform-core/api/Interface.IErrorPageParams.md +10 -11
  213. package/data/packages/platform-core/api/Interface.IEventKey.md +7 -8
  214. package/data/packages/platform-core/api/Interface.IEventMap.md +0 -1
  215. package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md +5 -6
  216. package/data/packages/platform-core/api/Interface.IHealthCheckResult.md +3 -4
  217. package/data/packages/platform-core/api/Interface.IHealthIndicator.md +3 -4
  218. package/data/packages/platform-core/api/Interface.IHostContentParams.md +8 -9
  219. package/data/packages/platform-core/api/Interface.IIdGenerator.md +7 -8
  220. package/data/packages/platform-core/api/Interface.IIntelligenceArtifact.md +1 -2
  221. package/data/packages/platform-core/api/Interface.IIntelligenceCapability.md +6 -7
  222. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityMetadata.md +4 -5
  223. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityPayload.md +2 -3
  224. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityRegistry.md +10 -11
  225. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityResult.md +2 -3
  226. package/data/packages/platform-core/api/Interface.IIntelligenceCompletionUsage.md +2 -3
  227. package/data/packages/platform-core/api/Interface.IIntelligenceContext.md +5 -6
  228. package/data/packages/platform-core/api/Interface.IIntelligenceContextBuilder.md +3 -4
  229. package/data/packages/platform-core/api/Interface.IIntelligenceConversationMessageSnapshot.md +4 -5
  230. package/data/packages/platform-core/api/Interface.IIntelligenceConversationSnapshot.md +3 -4
  231. package/data/packages/platform-core/api/Interface.IIntelligenceFollowUpQuestion.md +2 -3
  232. package/data/packages/platform-core/api/Interface.IIntelligenceIntent.md +2 -3
  233. package/data/packages/platform-core/api/Interface.IIntelligenceIntentEntity.md +1 -2
  234. package/data/packages/platform-core/api/Interface.IIntelligenceMessageModel.md +4 -5
  235. package/data/packages/platform-core/api/Interface.IIntelligenceMessagePayload.md +1 -2
  236. package/data/packages/platform-core/api/Interface.IIntelligencePrompt.md +1 -2
  237. package/data/packages/platform-core/api/Interface.IIntelligencePromptMessage.md +1 -2
  238. package/data/packages/platform-core/api/Interface.IIntelligenceProviderConfiguration.md +6 -7
  239. package/data/packages/platform-core/api/Interface.IIntelligenceResponseMessage.md +1 -2
  240. package/data/packages/platform-core/api/Interface.IIntelligenceTextCompletion.md +4 -5
  241. package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerationOptions.md +2 -3
  242. package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerator.md +4 -5
  243. package/data/packages/platform-core/api/Interface.ILayeredCache.md +34 -35
  244. package/data/packages/platform-core/api/Interface.ILayeredCacheOptions.md +4 -5
  245. package/data/packages/platform-core/api/Interface.IMappingBuilder.md +17 -18
  246. package/data/packages/platform-core/api/Interface.IMappingKey.md +7 -8
  247. package/data/packages/platform-core/api/Interface.IMappingProfile.md +2 -3
  248. package/data/packages/platform-core/api/Interface.IOtpService.md +8 -9
  249. package/data/packages/platform-core/api/Interface.IOtpUriOptions.md +2 -3
  250. package/data/packages/platform-core/api/Interface.IRedisLayeredCacheOptions.md +14 -15
  251. package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +4 -5
  252. package/data/packages/platform-core/api/Interface.IResourceMetadata.md +6 -7
  253. package/data/packages/platform-core/api/Interface.IResourceResult.md +1 -2
  254. package/data/packages/platform-core/api/Interface.IResourceStrategy.md +16 -17
  255. package/data/packages/platform-core/api/Interface.ISseEventData.md +3 -4
  256. package/data/packages/platform-core/api/Interface.ISseHub.md +16 -17
  257. package/data/packages/platform-core/api/Namespace.ISseEventData.md +3 -23
  258. package/data/packages/platform-core/api/TypeAlias.CamelCase.md +2 -3
  259. package/data/packages/platform-core/api/TypeAlias.IntelligenceConversationMessageRole.md +1 -3
  260. package/data/packages/platform-core/api/TypeAlias.IntelligenceProviderName.md +1 -2
  261. package/data/packages/platform-core/api/TypeAlias.ProblemDetail.md +5 -6
  262. package/data/packages/platform-core/api/TypeAlias.ProblemDetailTypeUrlResolver.md +4 -5
  263. package/data/packages/platform-core/api/TypeAlias.SetOptional.md +4 -5
  264. package/data/packages/platform-core/api/TypeAlias.StringValue.md +4 -2
  265. package/data/packages/platform-core/api/Variable.APP_PORT.md +14 -0
  266. package/data/packages/platform-core/api/Variable.APP_URL.md +14 -0
  267. package/data/packages/platform-core/api/Variable.APP_VERSION.md +14 -0
  268. package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +14 -0
  269. package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +14 -0
  270. package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +14 -0
  271. package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +14 -0
  272. package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +14 -0
  273. package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +14 -0
  274. package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +12 -0
  275. package/data/packages/platform-core/api/Variable.IntelligenceConversationMessageRoles.md +26 -0
  276. package/data/packages/platform-core/api/Variable.IntelligenceProviderNames.md +28 -0
  277. package/data/packages/platform-core/api/Variable.IpAddress.md +31 -0
  278. package/data/packages/platform-core/api/Variable.Lang.md +29 -0
  279. package/data/packages/platform-core/api/Variable.NODE_ENV.md +14 -0
  280. package/data/packages/platform-core/api/Variable.OTP_SERVICE_TOKEN.md +14 -0
  281. package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +14 -0
  282. package/data/packages/platform-core/api/Variable.TOTP_EPOCH_TOLERANCE.md +23 -0
  283. package/data/packages/platform-core/api/Variable.UserAgent.md +24 -0
  284. package/data/packages/platform-core/api/index.md +160 -620
  285. package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +6 -11
  286. package/data/packages/platform-database/api/Class.DatabaseModule.md +5 -10
  287. package/data/packages/platform-database/api/Class.DatabaseService.md +19 -24
  288. package/data/packages/platform-database/api/Class.PrismaService.md +7 -12
  289. package/data/packages/platform-database/api/Class.RepositoryBase.md +185 -125
  290. package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +5 -10
  291. package/data/packages/platform-database/api/Function.pageable.md +35 -0
  292. package/data/packages/platform-database/api/Function.paginator.md +22 -0
  293. package/data/packages/platform-database/api/Function.query.md +34 -0
  294. package/data/packages/platform-database/api/Function.skip.md +33 -0
  295. package/data/packages/platform-database/api/Function.transactionalQuery.md +31 -0
  296. package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +0 -5
  297. package/data/packages/platform-database/api/Interface.IPaginateOptions.md +1 -6
  298. package/data/packages/platform-database/api/Interface.IPaginatedResult.md +4 -9
  299. package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +7 -12
  300. package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +5 -10
  301. package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +2 -7
  302. package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +2 -7
  303. package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +7 -12
  304. package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +3 -8
  305. package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +3 -8
  306. package/data/packages/platform-database/api/index.md +27 -163
  307. package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +194 -20
  308. package/data/packages/platform-documents/api/Class.DocumentEngine.md +7 -12
  309. package/data/packages/platform-documents/api/Class.DocumentModule.md +2 -7
  310. package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +21 -26
  311. package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +5 -11
  312. package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +5 -10
  313. package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +8 -13
  314. package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +2 -7
  315. package/data/packages/platform-documents/api/Interface.IImagePayload.md +3 -8
  316. package/data/packages/platform-documents/api/Interface.IImageProcessor.md +18 -23
  317. package/data/packages/platform-documents/api/Interface.IRenderOptions.md +3 -8
  318. package/data/packages/platform-documents/api/Interface.IRenderResult.md +3 -8
  319. package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +1 -6
  320. package/data/packages/platform-documents/api/TypeAlias.EngineType.md +1 -6
  321. package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +1 -6
  322. package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +1 -6
  323. package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +1 -6
  324. package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +14 -0
  325. package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +14 -0
  326. package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +14 -0
  327. package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +14 -0
  328. package/data/packages/platform-documents/api/index.md +28 -72
  329. package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +184 -0
  330. package/data/packages/platform-esigning/api/Class.EsigningError.md +65 -0
  331. package/data/packages/platform-esigning/api/Class.EsigningModule.md +48 -0
  332. package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +90 -0
  333. package/data/packages/platform-esigning/api/Class.EsigningService.md +198 -0
  334. package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +249 -0
  335. package/data/packages/platform-esigning/api/Class.SigningProviderError.md +101 -0
  336. package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +78 -0
  337. package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +60 -0
  338. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +94 -0
  339. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +58 -0
  340. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +58 -0
  341. package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +46 -0
  342. package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +60 -0
  343. package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +82 -0
  344. package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +82 -0
  345. package/data/packages/platform-esigning/api/Interface.ISigner.md +82 -0
  346. package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +82 -0
  347. package/data/packages/platform-esigning/api/Interface.ISigningField.md +142 -0
  348. package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +142 -0
  349. package/data/packages/platform-esigning/api/Interface.ISigningSession.md +70 -0
  350. package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +14 -0
  351. package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +14 -0
  352. package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +14 -0
  353. package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +14 -0
  354. package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +14 -0
  355. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +14 -0
  356. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +14 -0
  357. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +14 -0
  358. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +14 -0
  359. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +14 -0
  360. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +14 -0
  361. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +14 -0
  362. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +14 -0
  363. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +14 -0
  364. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +14 -0
  365. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +14 -0
  366. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +14 -0
  367. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +14 -0
  368. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +14 -0
  369. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +14 -0
  370. package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +14 -0
  371. package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +14 -0
  372. package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +12 -0
  373. package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +12 -0
  374. package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +14 -0
  375. package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +14 -0
  376. package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +14 -0
  377. package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +14 -0
  378. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +14 -0
  379. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +14 -0
  380. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +14 -0
  381. package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +14 -0
  382. package/data/packages/platform-esigning/api/Variable.SignerRoles.md +30 -0
  383. package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +32 -0
  384. package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +38 -0
  385. package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +36 -0
  386. package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +38 -0
  387. package/data/packages/platform-esigning/api/index.md +84 -0
  388. package/data/packages/platform-esigning/index.md +691 -0
  389. package/data/packages/platform-logging/api/Class.LoggerModule.md +0 -5
  390. package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +14 -0
  391. package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +14 -0
  392. package/data/packages/platform-logging/api/index.md +7 -30
  393. package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +3 -10
  394. package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +30 -19
  395. package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +3 -10
  396. package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +14 -21
  397. package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +4 -9
  398. package/data/packages/platform-mailing/api/Class.MailModule.md +0 -5
  399. package/data/packages/platform-mailing/api/Class.MailService.md +27 -32
  400. package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +12 -17
  401. package/data/packages/platform-mailing/api/Class.MailVerificationService.md +14 -19
  402. package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +14 -21
  403. package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +14 -21
  404. package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +14 -21
  405. package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +14 -21
  406. package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +14 -21
  407. package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +18 -7
  408. package/data/packages/platform-mailing/api/Interface.IMailEvents.md +0 -5
  409. package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +1 -6
  410. package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +1 -6
  411. package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +14 -0
  412. package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +14 -0
  413. package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +14 -0
  414. package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +14 -0
  415. package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +12 -0
  416. package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +14 -0
  417. package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +14 -0
  418. package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +14 -0
  419. package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +14 -0
  420. package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +14 -0
  421. package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +14 -0
  422. package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +14 -0
  423. package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +14 -0
  424. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +14 -0
  425. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +14 -0
  426. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +14 -0
  427. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +14 -0
  428. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +14 -0
  429. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +14 -0
  430. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +16 -0
  431. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +14 -0
  432. package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +14 -0
  433. package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +14 -0
  434. package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +14 -0
  435. package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +14 -0
  436. package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +14 -0
  437. package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +14 -0
  438. package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +14 -0
  439. package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +14 -0
  440. package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +14 -0
  441. package/data/packages/platform-mailing/api/index.md +54 -384
  442. package/data/packages/platform-mcp/api/Class.McpDiscoveryService.md +8 -9
  443. package/data/packages/platform-mcp/api/Class.McpModule.md +8 -9
  444. package/data/packages/platform-mcp/api/Class.McpRegistryService.md +16 -17
  445. package/data/packages/platform-mcp/api/Class.McpServerService.md +19 -20
  446. package/data/packages/platform-mcp/api/Function.McpPrompt.md +28 -0
  447. package/data/packages/platform-mcp/api/Function.McpResource.md +28 -0
  448. package/data/packages/platform-mcp/api/Function.McpTool.md +28 -0
  449. package/data/packages/platform-mcp/api/Interface.IMcpHandlerMetadata.md +2 -3
  450. package/data/packages/platform-mcp/api/Interface.IMcpModuleAsyncOptions.md +8 -9
  451. package/data/packages/platform-mcp/api/Interface.IMcpModuleOptions.md +3 -4
  452. package/data/packages/platform-mcp/api/Interface.IMcpModuleOptionsFactory.md +3 -4
  453. package/data/packages/platform-mcp/api/Interface.IMcpPromptMetadata.md +3 -4
  454. package/data/packages/platform-mcp/api/Interface.IMcpResourceMetadata.md +4 -5
  455. package/data/packages/platform-mcp/api/Interface.IMcpToolMetadata.md +5 -6
  456. package/data/packages/platform-mcp/api/Interface.IRegisteredPrompt.md +3 -4
  457. package/data/packages/platform-mcp/api/Interface.IRegisteredResource.md +3 -4
  458. package/data/packages/platform-mcp/api/Interface.IRegisteredTool.md +3 -4
  459. package/data/packages/platform-mcp/api/Interface.ISseTransportOptions.md +0 -1
  460. package/data/packages/platform-mcp/api/Interface.IStreamableHttpTransportOptions.md +1 -2
  461. package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +14 -0
  462. package/data/packages/platform-mcp/api/index.md +27 -104
  463. package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +5 -10
  464. package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +5 -10
  465. package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +16 -21
  466. package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +2 -7
  467. package/data/packages/platform-openapi/api/Function.Api.md +35 -0
  468. package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +42 -0
  469. package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +18 -0
  470. package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +27 -0
  471. package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +5 -10
  472. package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +5 -10
  473. package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +14 -0
  474. package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +14 -0
  475. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +14 -0
  476. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +14 -0
  477. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +14 -0
  478. package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +12 -0
  479. package/data/packages/platform-openapi/api/index.md +24 -191
  480. package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +7 -12
  481. package/data/packages/platform-payments/api/Class.FeatureGuard.md +6 -11
  482. package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +7 -12
  483. package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +24 -29
  484. package/data/packages/platform-payments/api/Class.MollieClient.md +24 -29
  485. package/data/packages/platform-payments/api/Class.PaddleClient.md +24 -29
  486. package/data/packages/platform-payments/api/Class.PaymentClientPort.md +25 -30
  487. package/data/packages/platform-payments/api/Class.PaymentModule.md +2 -7
  488. package/data/packages/platform-payments/api/Class.StripeClient.md +24 -29
  489. package/data/packages/platform-payments/api/Function.RequiresFeature.md +25 -0
  490. package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +4 -9
  491. package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +5 -10
  492. package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +6 -11
  493. package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +8 -13
  494. package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +2 -7
  495. package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +3 -8
  496. package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +9 -14
  497. package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +12 -0
  498. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +14 -0
  499. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +14 -0
  500. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +14 -0
  501. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +14 -0
  502. package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +14 -0
  503. package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +14 -0
  504. package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +14 -0
  505. package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +14 -0
  506. package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +14 -0
  507. package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +14 -0
  508. package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +14 -0
  509. package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +14 -0
  510. package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +14 -0
  511. package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +14 -0
  512. package/data/packages/platform-payments/api/index.md +41 -221
  513. package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +3 -4
  514. package/data/packages/platform-reporting/api/Class.ReportingDatasetNotFoundError.md +3 -4
  515. package/data/packages/platform-reporting/api/Class.ReportingFacade.md +8 -9
  516. package/data/packages/platform-reporting/api/Class.ReportingModule.md +0 -1
  517. package/data/packages/platform-reporting/api/Interface.IReportingContributor.md +4 -5
  518. package/data/packages/platform-reporting/api/Interface.IReportingDataset.md +5 -6
  519. package/data/packages/platform-reporting/api/Interface.IReportingDatasetField.md +4 -5
  520. package/data/packages/platform-reporting/api/Interface.IReportingQuery.md +4 -5
  521. package/data/packages/platform-reporting/api/Interface.IReportingQueryFilter.md +2 -3
  522. package/data/packages/platform-reporting/api/Interface.IReportingQueryResult.md +4 -5
  523. package/data/packages/platform-reporting/api/Interface.IReportingQuerySort.md +1 -2
  524. package/data/packages/platform-reporting/api/TypeAlias.ReportingFieldType.md +1 -2
  525. package/data/packages/platform-reporting/api/TypeAlias.ReportingFilterOperator.md +1 -2
  526. package/data/packages/platform-reporting/api/TypeAlias.ReportingQueryResultRow.md +0 -1
  527. package/data/packages/platform-reporting/api/Variable.ReportingFieldTypes.md +30 -0
  528. package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +28 -0
  529. package/data/packages/platform-reporting/api/index.md +23 -71
  530. package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +22 -27
  531. package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +26 -31
  532. package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +23 -28
  533. package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +35 -40
  534. package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +2 -7
  535. package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +4 -9
  536. package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +22 -27
  537. package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +2 -7
  538. package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +8 -13
  539. package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +2 -7
  540. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +12 -0
  541. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +12 -0
  542. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +12 -0
  543. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md +12 -0
  544. package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +12 -0
  545. package/data/packages/platform-telemetry/api/index.md +20 -65
  546. package/package.json +1 -1
  547. package/data/packages/platform-authentication/api/_media/ENVIRONMENT_VARIABLES.md +0 -151
  548. package/data/packages/platform-logging/api/Class.AnalyticsService.md +0 -113
@@ -3,26 +3,21 @@ title: 'Interface: ICustomBlobProviderRegistration'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
- [**@breadstone/archipel-platform-blob-storage**](../)
8
-
9
- ---
10
-
11
6
  # Interface: ICustomBlobProviderRegistration
12
7
 
13
- Defined in: [BlobModule.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L32)
8
+ Defined in: [BlobModule.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L44)
14
9
 
15
10
  ## Properties
16
11
 
17
12
  ### kind
18
13
 
19
14
  ```ts
20
- kind: 'custom';
15
+ kind: "custom";
21
16
  ```
22
17
 
23
- Defined in: [BlobModule.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L33)
18
+ Defined in: [BlobModule.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L45)
24
19
 
25
- ---
20
+ ***
26
21
 
27
22
  ### useClass
28
23
 
@@ -30,4 +25,4 @@ Defined in: [BlobModule.ts:33](https://github.com/RueDeRennes/archipel/blob/main
30
25
  useClass: Type<IBlobProvider>;
31
26
  ```
32
27
 
33
- Defined in: [BlobModule.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L34)
28
+ Defined in: [BlobModule.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L46)
@@ -3,11 +3,6 @@ title: 'Interface: IVercelBlobProviderOptions'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
- [**@breadstone/archipel-platform-blob-storage**](../)
8
-
9
- ---
10
-
11
6
  # Interface: IVercelBlobProviderOptions
12
7
 
13
8
  Defined in: [providers/VercelBlobProvider.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L14)
@@ -22,7 +17,7 @@ accessToken: string;
22
17
 
23
18
  Defined in: [providers/VercelBlobProvider.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L16)
24
19
 
25
- ---
20
+ ***
26
21
 
27
22
  ### apiUrl
28
23
 
@@ -32,7 +27,7 @@ apiUrl: string;
32
27
 
33
28
  Defined in: [providers/VercelBlobProvider.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L15)
34
29
 
35
- ---
30
+ ***
36
31
 
37
32
  ### bucket?
38
33
 
@@ -42,7 +37,7 @@ optional bucket?: string;
42
37
 
43
38
  Defined in: [providers/VercelBlobProvider.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L17)
44
39
 
45
- ---
40
+ ***
46
41
 
47
42
  ### providerId?
48
43
 
@@ -52,7 +47,7 @@ optional providerId?: string;
52
47
 
53
48
  Defined in: [providers/VercelBlobProvider.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L20)
54
49
 
55
- ---
50
+ ***
56
51
 
57
52
  ### publicUrl?
58
53
 
@@ -62,7 +57,7 @@ optional publicUrl?: string;
62
57
 
63
58
  Defined in: [providers/VercelBlobProvider.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L19)
64
59
 
65
- ---
60
+ ***
66
61
 
67
62
  ### region?
68
63
 
@@ -3,26 +3,21 @@ title: 'Interface: IVercelBlobProviderRegistration'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
- [**@breadstone/archipel-platform-blob-storage**](../)
8
-
9
- ---
10
-
11
6
  # Interface: IVercelBlobProviderRegistration
12
7
 
13
- Defined in: [BlobModule.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L27)
8
+ Defined in: [BlobModule.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L29)
14
9
 
15
10
  ## Properties
16
11
 
17
12
  ### kind
18
13
 
19
14
  ```ts
20
- kind: 'vercel';
15
+ kind: "vercel";
21
16
  ```
22
17
 
23
- Defined in: [BlobModule.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L28)
18
+ Defined in: [BlobModule.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L30)
24
19
 
25
- ---
20
+ ***
26
21
 
27
22
  ### options?
28
23
 
@@ -30,4 +25,4 @@ Defined in: [BlobModule.ts:28](https://github.com/RueDeRennes/archipel/blob/main
30
25
  optional options?: Partial<IVercelBlobProviderOptions>;
31
26
  ```
32
27
 
33
- Defined in: [BlobModule.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L29)
28
+ Defined in: [BlobModule.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L31)
@@ -3,15 +3,10 @@ title: 'Type Alias: BlobDownloadResponseType'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
- [**@breadstone/archipel-platform-blob-storage**](../)
8
-
9
- ---
10
-
11
6
  # Type Alias: BlobDownloadResponseType
12
7
 
13
8
  ```ts
14
- type BlobDownloadResponseType = (typeof BlobDownloadResponseTypes)[keyof typeof BlobDownloadResponseTypes];
9
+ type BlobDownloadResponseType = typeof BlobDownloadResponseTypes[keyof typeof BlobDownloadResponseTypes];
15
10
  ```
16
11
 
17
- Defined in: [interfaces/IBlobProvider.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L23)
12
+ Defined in: [interfaces/IBlobProvider.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L25)
@@ -3,15 +3,10 @@ title: 'Type Alias: BlobUploadBody'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
- [**@breadstone/archipel-platform-blob-storage**](../)
8
-
9
- ---
10
-
11
6
  # Type Alias: BlobUploadBody
12
7
 
13
8
  ```ts
14
9
  type BlobUploadBody = Buffer | Readable;
15
10
  ```
16
11
 
17
- Defined in: [interfaces/IBlobProvider.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L25)
12
+ Defined in: [interfaces/IBlobProvider.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L27)
@@ -3,15 +3,14 @@ title: 'Type Alias: IBlobProviderRegistration'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
- [**@breadstone/archipel-platform-blob-storage**](../)
8
-
9
- ---
10
-
11
6
  # Type Alias: IBlobProviderRegistration
12
7
 
13
8
  ```ts
14
- type IBlobProviderRegistration = IVercelBlobProviderRegistration | ICustomBlobProviderRegistration;
9
+ type IBlobProviderRegistration =
10
+ | IVercelBlobProviderRegistration
11
+ | IAzureBlobProviderRegistration
12
+ | IAwsS3BlobProviderRegistration
13
+ | ICustomBlobProviderRegistration;
15
14
  ```
16
15
 
17
- Defined in: [BlobModule.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L37)
16
+ Defined in: [BlobModule.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L49)
@@ -0,0 +1,12 @@
1
+ ---
2
+ title: 'Variable: AWS\_S3\_PROVIDER\_OPTIONS'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: AWS\_S3\_PROVIDER\_OPTIONS
7
+
8
+ ```ts
9
+ const AWS_S3_PROVIDER_OPTIONS: typeof AWS_S3_PROVIDER_OPTIONS;
10
+ ```
11
+
12
+ Defined in: [tokens.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/tokens.ts#L6)
@@ -0,0 +1,12 @@
1
+ ---
2
+ title: 'Variable: AZURE\_BLOB\_PROVIDER\_OPTIONS'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: AZURE\_BLOB\_PROVIDER\_OPTIONS
7
+
8
+ ```ts
9
+ const AZURE_BLOB_PROVIDER_OPTIONS: typeof AZURE_BLOB_PROVIDER_OPTIONS;
10
+ ```
11
+
12
+ Defined in: [tokens.ts:5](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/tokens.ts#L5)
@@ -0,0 +1,12 @@
1
+ ---
2
+ title: 'Variable: BLOB\_PROVIDER'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: BLOB\_PROVIDER
7
+
8
+ ```ts
9
+ const BLOB_PROVIDER: typeof BLOB_PROVIDER;
10
+ ```
11
+
12
+ Defined in: [tokens.ts:3](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/tokens.ts#L3)
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Variable: BlobDownloadResponseTypes'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: BlobDownloadResponseTypes
7
+
8
+ ```ts
9
+ const BlobDownloadResponseTypes: {
10
+ ArrayBuffer: "arraybuffer";
11
+ Json: "json";
12
+ Stream: "stream";
13
+ Text: "text";
14
+ };
15
+ ```
16
+
17
+ Defined in: [interfaces/IBlobProvider.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L18)
18
+
19
+ ## Type Declaration
20
+
21
+ | Name | Type | Default value | Defined in |
22
+ | ------ | ------ | ------ | ------ |
23
+ | <a id="property-arraybuffer"></a> `ArrayBuffer` | `"arraybuffer"` | `'arraybuffer'` | [interfaces/IBlobProvider.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L19) |
24
+ | <a id="property-json"></a> `Json` | `"json"` | `'json'` | [interfaces/IBlobProvider.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L20) |
25
+ | <a id="property-stream"></a> `Stream` | `"stream"` | `'stream'` | [interfaces/IBlobProvider.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L21) |
26
+ | <a id="property-text"></a> `Text` | `"text"` | `'text'` | [interfaces/IBlobProvider.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L22) |
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Variable: BlobProviderKinds'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: BlobProviderKinds
7
+
8
+ ```ts
9
+ const BlobProviderKinds: {
10
+ AwsS3: "aws-s3";
11
+ Azure: "azure";
12
+ Custom: "custom";
13
+ Vercel: "vercel";
14
+ };
15
+ ```
16
+
17
+ Defined in: [interfaces/IBlobProvider.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L9)
18
+
19
+ ## Type Declaration
20
+
21
+ | Name | Type | Default value | Defined in |
22
+ | ------ | ------ | ------ | ------ |
23
+ | <a id="property-awss3"></a> `AwsS3` | `"aws-s3"` | `'aws-s3'` | [interfaces/IBlobProvider.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L13) |
24
+ | <a id="property-azure"></a> `Azure` | `"azure"` | `'azure'` | [interfaces/IBlobProvider.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L12) |
25
+ | <a id="property-custom"></a> `Custom` | `"custom"` | `'custom'` | [interfaces/IBlobProvider.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L10) |
26
+ | <a id="property-vercel"></a> `Vercel` | `"vercel"` | `'vercel'` | [interfaces/IBlobProvider.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L11) |
@@ -0,0 +1,12 @@
1
+ ---
2
+ title: 'Variable: VERCEL\_BLOB\_PROVIDER\_OPTIONS'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: VERCEL\_BLOB\_PROVIDER\_OPTIONS
7
+
8
+ ```ts
9
+ const VERCEL_BLOB_PROVIDER_OPTIONS: typeof VERCEL_BLOB_PROVIDER_OPTIONS;
10
+ ```
11
+
12
+ Defined in: [tokens.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/tokens.ts#L4)
@@ -3,109 +3,57 @@ title: '@breadstone/archipel-platform-blob-storage'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
- [**@breadstone/archipel-platform-blob-storage**](../)
8
-
9
- ---
10
-
11
6
  # @breadstone/archipel-platform-blob-storage
12
7
 
13
8
  ## Classes
14
9
 
15
- | Class | Description |
16
- | -------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | [BlobHealthIndicator](Class.BlobHealthIndicator) | Health indicator for blob service. |
18
- | [BlobModule](Class.BlobModule) | NestJS module responsible for providing blob storage services. |
19
- | [BlobObjectPersistencePort](Class.BlobObjectPersistencePort) | Abstract port for persisting blob object metadata. Consuming projects must provide a concrete implementation (e.g. backed by Prisma, Mongo, etc.) and register it via `BlobModule.forRoot({ objectPersistence: MyAdapter })`. |
20
- | [BlobService](Class.BlobService) | Provides a generic abstraction for blob storage operations independent of the underlying provider. |
21
- | [BlobVariantPersistencePort](Class.BlobVariantPersistencePort) | Abstract port for persisting blob variant metadata. Consuming projects must provide a concrete implementation and register it via `BlobModule.forRoot({ variantPersistence: MyAdapter })`. |
22
- | [VercelBlobProvider](Class.VercelBlobProvider) | Provides an implementation of [IBlobProvider](Interface.IBlobProvider) for Vercel Blob storage. |
10
+ | Class | Description |
11
+ | ------ | ------ |
12
+ | [AwsS3BlobProvider](Class.AwsS3BlobProvider) | Provides an implementation of [IBlobProvider](Interface.IBlobProvider) for Amazon S3. |
13
+ | [AzureBlobProvider](Class.AzureBlobProvider) | Provides an implementation of [IBlobProvider](Interface.IBlobProvider) for Microsoft Azure Blob Storage. |
14
+ | [BlobHealthIndicator](Class.BlobHealthIndicator) | Health indicator for blob service. |
15
+ | [BlobModule](Class.BlobModule) | NestJS module responsible for providing blob storage services. |
16
+ | [BlobObjectPersistencePort](Class.BlobObjectPersistencePort) | Abstract port for persisting blob object metadata. Consuming projects must provide a concrete implementation (e.g. backed by Prisma, Mongo, etc.) and register it via `BlobModule.forRoot({ objectPersistence: MyAdapter })`. |
17
+ | [BlobService](Class.BlobService) | Provides a generic abstraction for blob storage operations independent of the underlying provider. |
18
+ | [BlobVariantPersistencePort](Class.BlobVariantPersistencePort) | Abstract port for persisting blob variant metadata. Consuming projects must provide a concrete implementation and register it via `BlobModule.forRoot({ variantPersistence: MyAdapter })`. |
19
+ | [VercelBlobProvider](Class.VercelBlobProvider) | Provides an implementation of [IBlobProvider](Interface.IBlobProvider) for Vercel Blob storage. |
23
20
 
24
21
  ## Interfaces
25
22
 
26
- | Interface | Description |
27
- | ---------------------------------------------------------------------------- | ----------- |
28
- | [IBlobDeleteRequest](Interface.IBlobDeleteRequest) | - |
29
- | [IBlobDownloadRequest](Interface.IBlobDownloadRequest) | - |
30
- | [IBlobDownloadResult](Interface.IBlobDownloadResult) | - |
31
- | [IBlobModuleOptions](Interface.IBlobModuleOptions) | - |
32
- | [IBlobObjectMetadata](Interface.IBlobObjectMetadata) | - |
33
- | [IBlobProvider](Interface.IBlobProvider) | - |
34
- | [IBlobSignedUrlRequest](Interface.IBlobSignedUrlRequest) | - |
35
- | [IBlobUploadRequest](Interface.IBlobUploadRequest) | - |
36
- | [IBlobUploadResult](Interface.IBlobUploadResult) | - |
37
- | [ICustomBlobProviderRegistration](Interface.ICustomBlobProviderRegistration) | - |
38
- | [IVercelBlobProviderOptions](Interface.IVercelBlobProviderOptions) | - |
39
- | [IVercelBlobProviderRegistration](Interface.IVercelBlobProviderRegistration) | - |
23
+ | Interface | Description |
24
+ | ------ | ------ |
25
+ | [IAwsS3BlobProviderRegistration](Interface.IAwsS3BlobProviderRegistration) | - |
26
+ | [IAwsS3ProviderOptions](Interface.IAwsS3ProviderOptions) | - |
27
+ | [IAzureBlobProviderOptions](Interface.IAzureBlobProviderOptions) | - |
28
+ | [IAzureBlobProviderRegistration](Interface.IAzureBlobProviderRegistration) | - |
29
+ | [IBlobDeleteRequest](Interface.IBlobDeleteRequest) | - |
30
+ | [IBlobDownloadRequest](Interface.IBlobDownloadRequest) | - |
31
+ | [IBlobDownloadResult](Interface.IBlobDownloadResult) | - |
32
+ | [IBlobModuleOptions](Interface.IBlobModuleOptions) | - |
33
+ | [IBlobObjectMetadata](Interface.IBlobObjectMetadata) | - |
34
+ | [IBlobProvider](Interface.IBlobProvider) | - |
35
+ | [IBlobSignedUrlRequest](Interface.IBlobSignedUrlRequest) | - |
36
+ | [IBlobUploadRequest](Interface.IBlobUploadRequest) | - |
37
+ | [IBlobUploadResult](Interface.IBlobUploadResult) | - |
38
+ | [ICustomBlobProviderRegistration](Interface.ICustomBlobProviderRegistration) | - |
39
+ | [IVercelBlobProviderOptions](Interface.IVercelBlobProviderOptions) | - |
40
+ | [IVercelBlobProviderRegistration](Interface.IVercelBlobProviderRegistration) | - |
40
41
 
41
42
  ## Type Aliases
42
43
 
43
- | Type Alias | Description |
44
- | ---------------------------------------------------------------- | ----------- |
45
- | [BlobDownloadResponseType](TypeAlias.BlobDownloadResponseType) | - |
46
- | [BlobUploadBody](TypeAlias.BlobUploadBody) | - |
47
- | [IBlobProviderRegistration](TypeAlias.IBlobProviderRegistration) | - |
44
+ | Type Alias | Description |
45
+ | ------ | ------ |
46
+ | [BlobDownloadResponseType](TypeAlias.BlobDownloadResponseType) | - |
47
+ | [BlobUploadBody](TypeAlias.BlobUploadBody) | - |
48
+ | [IBlobProviderRegistration](TypeAlias.IBlobProviderRegistration) | - |
48
49
 
49
50
  ## Variables
50
51
 
51
- ### BLOB_PROVIDER
52
-
53
- ```ts
54
- const BLOB_PROVIDER: typeof BLOB_PROVIDER;
55
- ```
56
-
57
- Defined in: [tokens.ts:3](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/tokens.ts#L3)
58
-
59
- ---
60
-
61
- ### BlobDownloadResponseTypes
62
-
63
- ```ts
64
- const BlobDownloadResponseTypes: {
65
- ArrayBuffer: 'arraybuffer';
66
- Json: 'json';
67
- Stream: 'stream';
68
- Text: 'text';
69
- };
70
- ```
71
-
72
- Defined in: [interfaces/IBlobProvider.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L16)
73
-
74
- #### Type Declaration
75
-
76
- | Name | Type | Default value | Defined in |
77
- | ----------------------------------------------- | --------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
78
- | <a id="property-arraybuffer"></a> `ArrayBuffer` | `"arraybuffer"` | `'arraybuffer'` | [interfaces/IBlobProvider.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L17) |
79
- | <a id="property-json"></a> `Json` | `"json"` | `'json'` | [interfaces/IBlobProvider.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L18) |
80
- | <a id="property-stream"></a> `Stream` | `"stream"` | `'stream'` | [interfaces/IBlobProvider.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L19) |
81
- | <a id="property-text"></a> `Text` | `"text"` | `'text'` | [interfaces/IBlobProvider.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L20) |
82
-
83
- ---
84
-
85
- ### BlobProviderKinds
86
-
87
- ```ts
88
- const BlobProviderKinds: {
89
- Custom: 'custom';
90
- Vercel: 'vercel';
91
- };
92
- ```
93
-
94
- Defined in: [interfaces/IBlobProvider.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L9)
95
-
96
- #### Type Declaration
97
-
98
- | Name | Type | Default value | Defined in |
99
- | ------------------------------------- | ---------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
100
- | <a id="property-custom"></a> `Custom` | `"custom"` | `'custom'` | [interfaces/IBlobProvider.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L10) |
101
- | <a id="property-vercel"></a> `Vercel` | `"vercel"` | `'vercel'` | [interfaces/IBlobProvider.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L11) |
102
-
103
- ---
104
-
105
- ### VERCEL_BLOB_PROVIDER_OPTIONS
106
-
107
- ```ts
108
- const VERCEL_BLOB_PROVIDER_OPTIONS: typeof VERCEL_BLOB_PROVIDER_OPTIONS;
109
- ```
110
-
111
- Defined in: [tokens.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/tokens.ts#L4)
52
+ | Variable | Description |
53
+ | ------ | ------ |
54
+ | [AWS\_S3\_PROVIDER\_OPTIONS](Variable.AWS_S3_PROVIDER_OPTIONS) | - |
55
+ | [AZURE\_BLOB\_PROVIDER\_OPTIONS](Variable.AZURE_BLOB_PROVIDER_OPTIONS) | - |
56
+ | [BLOB\_PROVIDER](Variable.BLOB_PROVIDER) | - |
57
+ | [BlobDownloadResponseTypes](Variable.BlobDownloadResponseTypes) | - |
58
+ | [BlobProviderKinds](Variable.BlobProviderKinds) | - |
59
+ | [VERCEL\_BLOB\_PROVIDER\_OPTIONS](Variable.VERCEL_BLOB_PROVIDER_OPTIONS) | - |
@@ -3,7 +3,6 @@ title: 'Class: AppHealthIndicator'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Class: AppHealthIndicator
8
7
 
9
8
  Defined in: [terminus/AppHealthIndicator.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/terminus/AppHealthIndicator.ts#L15)
@@ -24,8 +23,8 @@ Constructs a new instance of the `AppHealthIndicator` class.
24
23
 
25
24
  #### Parameters
26
25
 
27
- | Parameter | Type |
28
- | --------------- | -------------------------------------- |
26
+ | Parameter | Type |
27
+ | ------ | ------ |
29
28
  | `configService` | [`ConfigService`](Class.ConfigService) |
30
29
 
31
30
  #### Returns
@@ -3,7 +3,6 @@ title: 'Class: BcryptService'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Class: BcryptService
8
7
 
9
8
  Defined in: [services/BcryptService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/BcryptService.ts#L15)
@@ -37,16 +36,16 @@ Compares the given data with the encrypted data.
37
36
 
38
37
  #### Parameters
39
38
 
40
- | Parameter | Type | Description |
41
- | ----------- | -------- | --------------------------------- |
42
- | `data` | `string` | The data to be compared |
39
+ | Parameter | Type | Description |
40
+ | ------ | ------ | ------ |
41
+ | `data` | `string` | The data to be compared |
43
42
  | `encrypted` | `string` | The encrypted data to be compared |
44
43
 
45
44
  #### Returns
46
45
 
47
46
  `Promise`\<`boolean`\>
48
47
 
49
- ---
48
+ ***
50
49
 
51
50
  ### hash()
52
51
 
@@ -60,9 +59,9 @@ Hashes the given data.
60
59
 
61
60
  #### Parameters
62
61
 
63
- | Parameter | Type | Description |
64
- | --------- | -------- | --------------------- |
65
- | `data` | `string` | The data to be hashed |
62
+ | Parameter | Type | Description |
63
+ | ------ | ------ | ------ |
64
+ | `data` | `string` | The data to be hashed |
66
65
 
67
66
  #### Returns
68
67
 
@@ -3,7 +3,6 @@ title: 'Class: BlobResourceStrategy'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Class: BlobResourceStrategy
8
7
 
9
8
  Defined in: [resources/strategies/BlobResourceStrategy.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L51)
@@ -28,10 +27,10 @@ Constructs a new instance of the `BlobResourceStrategy` class.
28
27
 
29
28
  #### Parameters
30
29
 
31
- | Parameter | Type |
32
- | ------------- | ---------------------------------------------------------------------- |
33
- | `blobService` | [`IBlobServiceAdapter`](Interface.IBlobServiceAdapter) |
34
- | `config` | [`IBlobResourceStrategyConfig`](Interface.IBlobResourceStrategyConfig) |
30
+ | Parameter | Type |
31
+ | ------ | ------ |
32
+ | `blobService` | [`IBlobServiceAdapter`](Interface.IBlobServiceAdapter) |
33
+ | `config` | [`IBlobResourceStrategyConfig`](Interface.IBlobResourceStrategyConfig) |
35
34
 
36
35
  #### Returns
37
36
 
@@ -76,9 +75,9 @@ Note: Blob storage is inherently async, so this delegates to existsAsync interna
76
75
 
77
76
  #### Parameters
78
77
 
79
- | Parameter | Type | Description |
80
- | --------- | -------- | ---------------- |
81
- | `key` | `string` | The resource key |
78
+ | Parameter | Type | Description |
79
+ | ------ | ------ | ------ |
80
+ | `key` | `string` | The resource key |
82
81
 
83
82
  #### Returns
84
83
 
@@ -90,7 +89,7 @@ True if the resource exists
90
89
 
91
90
  [`IResourceStrategy`](Interface.IResourceStrategy).[`exists`](Interface.IResourceStrategy#exists)
92
91
 
93
- ---
92
+ ***
94
93
 
95
94
  ### existsAsync()
96
95
 
@@ -104,9 +103,9 @@ Checks if a resource exists without loading it (asynchronous).
104
103
 
105
104
  #### Parameters
106
105
 
107
- | Parameter | Type | Description |
108
- | --------- | -------- | ---------------- |
109
- | `key` | `string` | The resource key |
106
+ | Parameter | Type | Description |
107
+ | ------ | ------ | ------ |
108
+ | `key` | `string` | The resource key |
110
109
 
111
110
  #### Returns
112
111
 
@@ -118,7 +117,7 @@ Promise resolving to true if the resource exists
118
117
 
119
118
  [`IResourceStrategy`](Interface.IResourceStrategy).[`existsAsync`](Interface.IResourceStrategy#existsasync)
120
119
 
121
- ---
120
+ ***
122
121
 
123
122
  ### load()
124
123
 
@@ -133,9 +132,9 @@ Note: Blob storage is inherently async, so this delegates to loadAsync internall
133
132
 
134
133
  #### Parameters
135
134
 
136
- | Parameter | Type | Description |
137
- | --------- | -------- | ---------------- |
138
- | `key` | `string` | The resource key |
135
+ | Parameter | Type | Description |
136
+ | ------ | ------ | ------ |
137
+ | `key` | `string` | The resource key |
139
138
 
140
139
  #### Returns
141
140
 
@@ -147,7 +146,7 @@ The resource result or undefined if not found
147
146
 
148
147
  [`IResourceStrategy`](Interface.IResourceStrategy).[`load`](Interface.IResourceStrategy#load)
149
148
 
150
- ---
149
+ ***
151
150
 
152
151
  ### loadAsync()
153
152
 
@@ -161,9 +160,9 @@ Loads a resource by its key (asynchronous).
161
160
 
162
161
  #### Parameters
163
162
 
164
- | Parameter | Type | Description |
165
- | --------- | -------- | ---------------- |
166
- | `key` | `string` | The resource key |
163
+ | Parameter | Type | Description |
164
+ | ------ | ------ | ------ |
165
+ | `key` | `string` | The resource key |
167
166
 
168
167
  #### Returns
169
168
 
@@ -175,7 +174,7 @@ Promise resolving to the resource result or undefined if not found
175
174
 
176
175
  [`IResourceStrategy`](Interface.IResourceStrategy).[`loadAsync`](Interface.IResourceStrategy#loadasync)
177
176
 
178
- ---
177
+ ***
179
178
 
180
179
  ### whatDoIHave()
181
180