@breadstone/archipel-mcp 0.0.2 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (548) hide show
  1. package/data/packages/index.md +4 -2
  2. package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +20 -19
  3. package/data/packages/platform-analytics/api/Class.AnalyticsModule.md +3 -2
  4. package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +22 -21
  5. package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +22 -21
  6. package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +20 -19
  7. package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +22 -21
  8. package/data/packages/platform-analytics/api/Interface.IAnalyticsBreadcrumb.md +4 -3
  9. package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md +3 -2
  10. package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md +4 -3
  11. package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md +2 -1
  12. package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md +3 -2
  13. package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md +2 -1
  14. package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md +3 -2
  15. package/data/packages/platform-analytics/api/Variable.DD_ENV.md +2 -1
  16. package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md +2 -1
  17. package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md +3 -2
  18. package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md +2 -1
  19. package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md +2 -1
  20. package/data/packages/platform-analytics/api/index.md +26 -25
  21. package/data/packages/platform-analytics/index.md +170 -0
  22. package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +5 -4
  23. package/data/packages/platform-authentication/api/Class.AppleStrategy.md +16 -15
  24. package/data/packages/platform-authentication/api/Class.AuthModule.md +6 -5
  25. package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +11 -10
  26. package/data/packages/platform-authentication/api/Class.AuthTokenService.md +6 -5
  27. package/data/packages/platform-authentication/api/Class.ChallengeService.md +27 -26
  28. package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +5 -4
  29. package/data/packages/platform-authentication/api/Class.GithubStrategy.md +17 -16
  30. package/data/packages/platform-authentication/api/Class.GoogleStrategy.md +14 -13
  31. package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +5 -4
  32. package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +16 -15
  33. package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +11 -10
  34. package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +5 -4
  35. package/data/packages/platform-authentication/api/Class.MfaService.md +55 -54
  36. package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +9 -8
  37. package/data/packages/platform-authentication/api/Class.MicrosoftStrategy.md +14 -13
  38. package/data/packages/platform-authentication/api/Class.RolesGuard.md +6 -5
  39. package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +5 -4
  40. package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +26 -25
  41. package/data/packages/platform-authentication/api/Class.SessionResponse.md +13 -12
  42. package/data/packages/platform-authentication/api/Class.SessionService.md +34 -33
  43. package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +10 -9
  44. package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +3 -2
  45. package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +3 -2
  46. package/data/packages/platform-authentication/api/Class.VerificationService.md +30 -29
  47. package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +17 -16
  48. package/data/packages/platform-authentication/api/Function.Token.md +1 -0
  49. package/data/packages/platform-authentication/api/Function.UseRoles.md +3 -2
  50. package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md +6 -5
  51. package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +8 -7
  52. package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +8 -7
  53. package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +6 -5
  54. package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +11 -10
  55. package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +1 -0
  56. package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +4 -3
  57. package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +10 -9
  58. package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +8 -7
  59. package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +15 -14
  60. package/data/packages/platform-authentication/api/Interface.ISignInResult.md +6 -5
  61. package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +4 -3
  62. package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +6 -5
  63. package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +5 -4
  64. package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +3 -2
  65. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +2 -1
  66. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +2 -1
  67. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +2 -1
  68. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +2 -1
  69. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +2 -1
  70. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +15 -0
  71. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +2 -1
  72. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +2 -1
  73. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +2 -1
  74. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +2 -1
  75. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +2 -1
  76. package/data/packages/platform-authentication/api/Variable.AUTH_JWT_EXPIRES_IN.md +2 -1
  77. package/data/packages/platform-authentication/api/Variable.AUTH_JWT_SECRET.md +2 -1
  78. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN.md +2 -1
  79. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +2 -1
  80. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +2 -1
  81. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ENCRYPTION_KEY.md +2 -1
  82. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_MAX_ATTEMPTS.md +2 -1
  83. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +2 -1
  84. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +2 -1
  85. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +2 -1
  86. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +2 -1
  87. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +2 -1
  88. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +2 -1
  89. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +2 -1
  90. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +2 -1
  91. package/data/packages/platform-authentication/api/Variable.AUTH_VERIFY_JWT_EXPIRES_IN.md +2 -1
  92. package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +3 -2
  93. package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +3 -2
  94. package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +3 -2
  95. package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +4 -3
  96. package/data/packages/platform-authentication/api/Variable.ROLES_KEY.md +3 -2
  97. package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +3 -2
  98. package/data/packages/platform-authentication/api/Variable.SESSION_LIST_MAPPING_KEY.md +2 -1
  99. package/data/packages/platform-authentication/api/Variable.SESSION_MAPPING_KEY.md +2 -1
  100. package/data/packages/platform-authentication/api/Variable.User.md +3 -2
  101. package/data/packages/platform-authentication/api/index.md +88 -86
  102. package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +24 -23
  103. package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +19 -18
  104. package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +6 -5
  105. package/data/packages/platform-blob-storage/api/Class.BlobModule.md +5 -4
  106. package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +13 -12
  107. package/data/packages/platform-blob-storage/api/Class.BlobService.md +46 -45
  108. package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +8 -7
  109. package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +19 -18
  110. package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +6 -5
  111. package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +6 -5
  112. package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +3 -2
  113. package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +6 -5
  114. package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +3 -2
  115. package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +4 -3
  116. package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +7 -6
  117. package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +9 -8
  118. package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +13 -12
  119. package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +15 -14
  120. package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +4 -3
  121. package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +9 -8
  122. package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +2 -1
  123. package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +6 -5
  124. package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +6 -5
  125. package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +6 -5
  126. package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +2 -1
  127. package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +1 -0
  128. package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +3 -2
  129. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +2 -1
  130. package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +2 -1
  131. package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +2 -1
  132. package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +10 -9
  133. package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +11 -10
  134. package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +2 -1
  135. package/data/packages/platform-blob-storage/api/index.md +42 -41
  136. package/data/packages/platform-blob-storage/index.md +77 -22
  137. package/data/packages/platform-core/api/Class.AppHealthIndicator.md +3 -2
  138. package/data/packages/platform-core/api/Class.BcryptService.md +8 -7
  139. package/data/packages/platform-core/api/Class.BlobResourceStrategy.md +21 -20
  140. package/data/packages/platform-core/api/Class.BooleanUtils.md +13 -12
  141. package/data/packages/platform-core/api/Class.CUIDGenerator.md +18 -17
  142. package/data/packages/platform-core/api/Class.CasingInterceptor.md +11 -10
  143. package/data/packages/platform-core/api/Class.CatchUtils.md +16 -15
  144. package/data/packages/platform-core/api/Class.ConfigModule.md +8 -7
  145. package/data/packages/platform-core/api/Class.ConfigRegistry.md +9 -8
  146. package/data/packages/platform-core/api/Class.ConfigService.md +27 -26
  147. package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +18 -17
  148. package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +5 -4
  149. package/data/packages/platform-core/api/Class.CryptoService.md +4 -3
  150. package/data/packages/platform-core/api/Class.DateTimeUtils.md +13 -12
  151. package/data/packages/platform-core/api/Class.DeviceParserService.md +3 -2
  152. package/data/packages/platform-core/api/Class.EmbeddedResourceStrategy.md +23 -22
  153. package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +18 -17
  154. package/data/packages/platform-core/api/Class.ErrorTemplateService.md +16 -15
  155. package/data/packages/platform-core/api/Class.EventHub.md +26 -25
  156. package/data/packages/platform-core/api/Class.EventModule.md +1 -0
  157. package/data/packages/platform-core/api/Class.FileConfigStrategy.md +20 -19
  158. package/data/packages/platform-core/api/Class.FileResourceStrategy.md +20 -19
  159. package/data/packages/platform-core/api/Class.GUIDGenerator.md +8 -7
  160. package/data/packages/platform-core/api/Class.GlobalExceptionFilter.md +8 -7
  161. package/data/packages/platform-core/api/Class.HealthModule.md +3 -2
  162. package/data/packages/platform-core/api/Class.HealthOrchestrator.md +4 -3
  163. package/data/packages/platform-core/api/Class.HostModule.md +2 -0
  164. package/data/packages/platform-core/api/Class.HostService.md +14 -13
  165. package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md +9 -8
  166. package/data/packages/platform-core/api/Class.IdGeneratorBase.md +8 -7
  167. package/data/packages/platform-core/api/Class.IdentifierModule.md +4 -3
  168. package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistrarBase.md +5 -4
  169. package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistry.md +11 -10
  170. package/data/packages/platform-core/api/Class.IntelligenceModule.md +1 -0
  171. package/data/packages/platform-core/api/Class.IntelligenceTextGenerator.md +7 -6
  172. package/data/packages/platform-core/api/Class.LimitRequestSizeMiddleware.md +9 -8
  173. package/data/packages/platform-core/api/Class.LocalizedTextRequest.md +2 -1
  174. package/data/packages/platform-core/api/Class.LocalizedTextResponse.md +2 -1
  175. package/data/packages/platform-core/api/Class.MappingBuilder.md +19 -18
  176. package/data/packages/platform-core/api/Class.MappingModule.md +3 -2
  177. package/data/packages/platform-core/api/Class.MappingNotRegisteredError.md +6 -5
  178. package/data/packages/platform-core/api/Class.MappingProfileBase.md +3 -2
  179. package/data/packages/platform-core/api/Class.MappingService.md +53 -52
  180. package/data/packages/platform-core/api/Class.MemoryLayeredCache.md +38 -37
  181. package/data/packages/platform-core/api/Class.NoopCacheMetricsRecorder.md +20 -19
  182. package/data/packages/platform-core/api/Class.NormalizedUtils.md +21 -20
  183. package/data/packages/platform-core/api/Class.OtpService.md +9 -8
  184. package/data/packages/platform-core/api/Class.PageableRequest.md +2 -1
  185. package/data/packages/platform-core/api/Class.PageableResponse.md +4 -3
  186. package/data/packages/platform-core/api/Class.ProblemDetailException.md +7 -6
  187. package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +12 -11
  188. package/data/packages/platform-core/api/Class.QuantityResponse.md +2 -1
  189. package/data/packages/platform-core/api/Class.RedisLayeredCache.md +40 -39
  190. package/data/packages/platform-core/api/Class.ResourceManager.md +89 -88
  191. package/data/packages/platform-core/api/Class.ResourceModule.md +4 -3
  192. package/data/packages/platform-core/api/Class.ResponseReturn.md +104 -102
  193. package/data/packages/platform-core/api/Class.SseHub.md +24 -23
  194. package/data/packages/platform-core/api/Class.SseModule.md +4 -3
  195. package/data/packages/platform-core/api/Class.TimeStampResponse.md +2 -1
  196. package/data/packages/platform-core/api/Class.TypeMappingNotRegisteredError.md +6 -5
  197. package/data/packages/platform-core/api/Class.UUIDGenerator.md +8 -7
  198. package/data/packages/platform-core/api/Class.UserAvatarGeneratorService.md +5 -4
  199. package/data/packages/platform-core/api/Class.UserNameGeneratorService.md +5 -4
  200. package/data/packages/platform-core/api/Function.Public.md +1 -0
  201. package/data/packages/platform-core/api/Function.createConfigKey.md +9 -7
  202. package/data/packages/platform-core/api/Function.createEventKey.md +7 -6
  203. package/data/packages/platform-core/api/Function.createMappingKey.md +7 -6
  204. package/data/packages/platform-core/api/Function.env.md +5 -4
  205. package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +3 -2
  206. package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +5 -4
  207. package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md +2 -1
  208. package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md +6 -5
  209. package/data/packages/platform-core/api/Interface.ICacheMetricsRecorder.md +20 -19
  210. package/data/packages/platform-core/api/Interface.ICacheStats.md +5 -4
  211. package/data/packages/platform-core/api/Interface.IConfigKey.md +17 -16
  212. package/data/packages/platform-core/api/Interface.IConfigModuleOptions.md +4 -3
  213. package/data/packages/platform-core/api/Interface.IConfigRegistryEntry.md +7 -6
  214. package/data/packages/platform-core/api/Interface.IDeviceInfo.md +7 -6
  215. package/data/packages/platform-core/api/Interface.IErrorPageParams.md +11 -10
  216. package/data/packages/platform-core/api/Interface.IEventKey.md +8 -7
  217. package/data/packages/platform-core/api/Interface.IEventMap.md +1 -0
  218. package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md +6 -5
  219. package/data/packages/platform-core/api/Interface.IHealthCheckResult.md +4 -3
  220. package/data/packages/platform-core/api/Interface.IHealthIndicator.md +4 -3
  221. package/data/packages/platform-core/api/Interface.IHostContentParams.md +9 -8
  222. package/data/packages/platform-core/api/Interface.IIdGenerator.md +8 -7
  223. package/data/packages/platform-core/api/Interface.IIntelligenceArtifact.md +2 -1
  224. package/data/packages/platform-core/api/Interface.IIntelligenceCapability.md +7 -6
  225. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityMetadata.md +5 -4
  226. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityPayload.md +3 -2
  227. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityRegistry.md +11 -10
  228. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityResult.md +3 -2
  229. package/data/packages/platform-core/api/Interface.IIntelligenceCompletionUsage.md +3 -2
  230. package/data/packages/platform-core/api/Interface.IIntelligenceContext.md +6 -5
  231. package/data/packages/platform-core/api/Interface.IIntelligenceContextBuilder.md +4 -3
  232. package/data/packages/platform-core/api/Interface.IIntelligenceConversationMessageSnapshot.md +5 -4
  233. package/data/packages/platform-core/api/Interface.IIntelligenceConversationSnapshot.md +4 -3
  234. package/data/packages/platform-core/api/Interface.IIntelligenceFollowUpQuestion.md +3 -2
  235. package/data/packages/platform-core/api/Interface.IIntelligenceIntent.md +3 -2
  236. package/data/packages/platform-core/api/Interface.IIntelligenceIntentEntity.md +2 -1
  237. package/data/packages/platform-core/api/Interface.IIntelligenceMessageModel.md +5 -4
  238. package/data/packages/platform-core/api/Interface.IIntelligenceMessagePayload.md +2 -1
  239. package/data/packages/platform-core/api/Interface.IIntelligencePrompt.md +2 -1
  240. package/data/packages/platform-core/api/Interface.IIntelligencePromptMessage.md +2 -1
  241. package/data/packages/platform-core/api/Interface.IIntelligenceProviderConfiguration.md +7 -6
  242. package/data/packages/platform-core/api/Interface.IIntelligenceResponseMessage.md +2 -1
  243. package/data/packages/platform-core/api/Interface.IIntelligenceTextCompletion.md +5 -4
  244. package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerationOptions.md +3 -2
  245. package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerator.md +5 -4
  246. package/data/packages/platform-core/api/Interface.ILayeredCache.md +35 -34
  247. package/data/packages/platform-core/api/Interface.ILayeredCacheOptions.md +5 -4
  248. package/data/packages/platform-core/api/Interface.IMappingBuilder.md +18 -17
  249. package/data/packages/platform-core/api/Interface.IMappingKey.md +8 -7
  250. package/data/packages/platform-core/api/Interface.IMappingProfile.md +3 -2
  251. package/data/packages/platform-core/api/Interface.IOtpService.md +9 -8
  252. package/data/packages/platform-core/api/Interface.IOtpUriOptions.md +3 -2
  253. package/data/packages/platform-core/api/Interface.IRedisLayeredCacheOptions.md +15 -14
  254. package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +5 -4
  255. package/data/packages/platform-core/api/Interface.IResourceMetadata.md +7 -6
  256. package/data/packages/platform-core/api/Interface.IResourceResult.md +2 -1
  257. package/data/packages/platform-core/api/Interface.IResourceStrategy.md +17 -16
  258. package/data/packages/platform-core/api/Interface.ISseEventData.md +4 -3
  259. package/data/packages/platform-core/api/Interface.ISseHub.md +17 -16
  260. package/data/packages/platform-core/api/Namespace.ISseEventData.md +3 -2
  261. package/data/packages/platform-core/api/TypeAlias.CamelCase.md +3 -2
  262. package/data/packages/platform-core/api/TypeAlias.IntelligenceConversationMessageRole.md +3 -1
  263. package/data/packages/platform-core/api/TypeAlias.IntelligenceProviderName.md +2 -1
  264. package/data/packages/platform-core/api/TypeAlias.ProblemDetail.md +6 -5
  265. package/data/packages/platform-core/api/TypeAlias.ProblemDetailTypeUrlResolver.md +5 -4
  266. package/data/packages/platform-core/api/TypeAlias.SetOptional.md +5 -4
  267. package/data/packages/platform-core/api/TypeAlias.StringValue.md +2 -4
  268. package/data/packages/platform-core/api/Variable.APP_PORT.md +2 -1
  269. package/data/packages/platform-core/api/Variable.APP_URL.md +2 -1
  270. package/data/packages/platform-core/api/Variable.APP_VERSION.md +2 -1
  271. package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +2 -1
  272. package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +2 -1
  273. package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +2 -1
  274. package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +2 -1
  275. package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +2 -1
  276. package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +2 -1
  277. package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +3 -2
  278. package/data/packages/platform-core/api/Variable.IntelligenceConversationMessageRoles.md +8 -7
  279. package/data/packages/platform-core/api/Variable.IntelligenceProviderNames.md +10 -9
  280. package/data/packages/platform-core/api/Variable.IpAddress.md +7 -6
  281. package/data/packages/platform-core/api/Variable.Lang.md +6 -5
  282. package/data/packages/platform-core/api/Variable.NODE_ENV.md +2 -1
  283. package/data/packages/platform-core/api/Variable.OTP_SERVICE_TOKEN.md +2 -1
  284. package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +3 -2
  285. package/data/packages/platform-core/api/Variable.TOTP_EPOCH_TOLERANCE.md +8 -7
  286. package/data/packages/platform-core/api/Variable.UserAgent.md +3 -2
  287. package/data/packages/platform-core/api/index.md +161 -160
  288. package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +7 -6
  289. package/data/packages/platform-database/api/Class.DatabaseModule.md +6 -5
  290. package/data/packages/platform-database/api/Class.DatabaseService.md +20 -19
  291. package/data/packages/platform-database/api/Class.PrismaService.md +8 -7
  292. package/data/packages/platform-database/api/Class.RepositoryBase.md +127 -126
  293. package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +6 -5
  294. package/data/packages/platform-database/api/Function.pageable.md +10 -13
  295. package/data/packages/platform-database/api/Function.paginator.md +3 -2
  296. package/data/packages/platform-database/api/Function.query.md +8 -7
  297. package/data/packages/platform-database/api/Function.skip.md +6 -5
  298. package/data/packages/platform-database/api/Function.transactionalQuery.md +7 -6
  299. package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +1 -0
  300. package/data/packages/platform-database/api/Interface.IPaginateOptions.md +2 -1
  301. package/data/packages/platform-database/api/Interface.IPaginatedResult.md +5 -4
  302. package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +8 -7
  303. package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +6 -5
  304. package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +3 -2
  305. package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +3 -2
  306. package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +8 -7
  307. package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +4 -3
  308. package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +4 -3
  309. package/data/packages/platform-database/api/index.md +28 -27
  310. package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +33 -31
  311. package/data/packages/platform-documents/api/Class.DocumentEngine.md +8 -7
  312. package/data/packages/platform-documents/api/Class.DocumentModule.md +3 -2
  313. package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +22 -21
  314. package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +7 -5
  315. package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +6 -5
  316. package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +9 -8
  317. package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +3 -2
  318. package/data/packages/platform-documents/api/Interface.IImagePayload.md +4 -3
  319. package/data/packages/platform-documents/api/Interface.IImageProcessor.md +19 -18
  320. package/data/packages/platform-documents/api/Interface.IRenderOptions.md +4 -3
  321. package/data/packages/platform-documents/api/Interface.IRenderResult.md +4 -3
  322. package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +2 -1
  323. package/data/packages/platform-documents/api/TypeAlias.EngineType.md +2 -1
  324. package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +2 -1
  325. package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +2 -1
  326. package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +2 -1
  327. package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +2 -1
  328. package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +2 -1
  329. package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +2 -1
  330. package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +2 -1
  331. package/data/packages/platform-documents/api/index.md +29 -28
  332. package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +21 -20
  333. package/data/packages/platform-esigning/api/Class.EsigningError.md +5 -4
  334. package/data/packages/platform-esigning/api/Class.EsigningModule.md +3 -2
  335. package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +10 -9
  336. package/data/packages/platform-esigning/api/Class.EsigningService.md +25 -24
  337. package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +25 -24
  338. package/data/packages/platform-esigning/api/Class.SigningProviderError.md +10 -9
  339. package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +4 -3
  340. package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +3 -2
  341. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +7 -6
  342. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +4 -3
  343. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +4 -3
  344. package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +3 -2
  345. package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +4 -3
  346. package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +6 -5
  347. package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +6 -5
  348. package/data/packages/platform-esigning/api/Interface.ISigner.md +6 -5
  349. package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +6 -5
  350. package/data/packages/platform-esigning/api/Interface.ISigningField.md +11 -10
  351. package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +11 -10
  352. package/data/packages/platform-esigning/api/Interface.ISigningSession.md +5 -4
  353. package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +2 -1
  354. package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +2 -1
  355. package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +2 -1
  356. package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +2 -1
  357. package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +2 -1
  358. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +2 -1
  359. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +2 -1
  360. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +3 -2
  361. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +2 -1
  362. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +2 -1
  363. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +2 -1
  364. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +2 -1
  365. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +3 -2
  366. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +2 -1
  367. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +2 -1
  368. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +2 -1
  369. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +2 -1
  370. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +2 -1
  371. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +3 -2
  372. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +2 -1
  373. package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +2 -1
  374. package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +2 -1
  375. package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +2 -1
  376. package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +2 -1
  377. package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +2 -1
  378. package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +3 -2
  379. package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +2 -1
  380. package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +2 -1
  381. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +2 -1
  382. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +2 -1
  383. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +3 -2
  384. package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +2 -1
  385. package/data/packages/platform-esigning/api/Variable.SignerRoles.md +13 -12
  386. package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +15 -14
  387. package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +21 -20
  388. package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +19 -18
  389. package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +21 -20
  390. package/data/packages/platform-esigning/api/index.md +66 -65
  391. package/data/packages/platform-logging/api/Class.LoggerModule.md +1 -0
  392. package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +2 -1
  393. package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +3 -2
  394. package/data/packages/platform-logging/api/index.md +8 -7
  395. package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +3 -2
  396. package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +12 -11
  397. package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +3 -2
  398. package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +14 -13
  399. package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +5 -4
  400. package/data/packages/platform-mailing/api/Class.MailModule.md +1 -0
  401. package/data/packages/platform-mailing/api/Class.MailService.md +28 -27
  402. package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +13 -12
  403. package/data/packages/platform-mailing/api/Class.MailVerificationService.md +15 -14
  404. package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +14 -13
  405. package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +14 -13
  406. package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +14 -13
  407. package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +14 -13
  408. package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +14 -13
  409. package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +3 -2
  410. package/data/packages/platform-mailing/api/Interface.IMailEvents.md +1 -0
  411. package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +2 -1
  412. package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +2 -1
  413. package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +2 -1
  414. package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +3 -2
  415. package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +2 -1
  416. package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +2 -1
  417. package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +2 -1
  418. package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +2 -1
  419. package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +2 -1
  420. package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +2 -1
  421. package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +2 -1
  422. package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +2 -1
  423. package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +2 -1
  424. package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +2 -1
  425. package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +2 -1
  426. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +2 -1
  427. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +2 -1
  428. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +2 -1
  429. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +2 -1
  430. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +2 -1
  431. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +2 -1
  432. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +2 -1
  433. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +2 -1
  434. package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +2 -1
  435. package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +3 -2
  436. package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +2 -1
  437. package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +3 -2
  438. package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +2 -1
  439. package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +3 -2
  440. package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +2 -1
  441. package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +3 -2
  442. package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +3 -2
  443. package/data/packages/platform-mailing/api/index.md +55 -54
  444. package/data/packages/platform-mcp/api/Class.McpDiscoveryService.md +9 -8
  445. package/data/packages/platform-mcp/api/Class.McpModule.md +9 -8
  446. package/data/packages/platform-mcp/api/Class.McpRegistryService.md +17 -16
  447. package/data/packages/platform-mcp/api/Class.McpServerService.md +20 -19
  448. package/data/packages/platform-mcp/api/Function.McpPrompt.md +3 -2
  449. package/data/packages/platform-mcp/api/Function.McpResource.md +3 -2
  450. package/data/packages/platform-mcp/api/Function.McpTool.md +3 -2
  451. package/data/packages/platform-mcp/api/Interface.IMcpHandlerMetadata.md +3 -2
  452. package/data/packages/platform-mcp/api/Interface.IMcpModuleAsyncOptions.md +9 -8
  453. package/data/packages/platform-mcp/api/Interface.IMcpModuleOptions.md +4 -3
  454. package/data/packages/platform-mcp/api/Interface.IMcpModuleOptionsFactory.md +4 -3
  455. package/data/packages/platform-mcp/api/Interface.IMcpPromptMetadata.md +4 -3
  456. package/data/packages/platform-mcp/api/Interface.IMcpResourceMetadata.md +5 -4
  457. package/data/packages/platform-mcp/api/Interface.IMcpToolMetadata.md +6 -5
  458. package/data/packages/platform-mcp/api/Interface.IRegisteredPrompt.md +4 -3
  459. package/data/packages/platform-mcp/api/Interface.IRegisteredResource.md +4 -3
  460. package/data/packages/platform-mcp/api/Interface.IRegisteredTool.md +4 -3
  461. package/data/packages/platform-mcp/api/Interface.ISseTransportOptions.md +1 -0
  462. package/data/packages/platform-mcp/api/Interface.IStreamableHttpTransportOptions.md +2 -1
  463. package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +2 -1
  464. package/data/packages/platform-mcp/api/index.md +27 -26
  465. package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +6 -5
  466. package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +6 -5
  467. package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +17 -16
  468. package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +3 -2
  469. package/data/packages/platform-openapi/api/Function.Api.md +14 -13
  470. package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +5 -4
  471. package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +1 -0
  472. package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +7 -8
  473. package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +6 -5
  474. package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +6 -5
  475. package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +2 -1
  476. package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +3 -2
  477. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +2 -1
  478. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +2 -1
  479. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +2 -1
  480. package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +3 -2
  481. package/data/packages/platform-openapi/api/index.md +25 -24
  482. package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +8 -7
  483. package/data/packages/platform-payments/api/Class.FeatureGuard.md +7 -6
  484. package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +8 -7
  485. package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +25 -24
  486. package/data/packages/platform-payments/api/Class.MollieClient.md +25 -24
  487. package/data/packages/platform-payments/api/Class.PaddleClient.md +25 -24
  488. package/data/packages/platform-payments/api/Class.PaymentClientPort.md +26 -25
  489. package/data/packages/platform-payments/api/Class.PaymentModule.md +3 -2
  490. package/data/packages/platform-payments/api/Class.StripeClient.md +25 -24
  491. package/data/packages/platform-payments/api/Function.RequiresFeature.md +3 -2
  492. package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +5 -4
  493. package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +6 -5
  494. package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +7 -6
  495. package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +9 -8
  496. package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +3 -2
  497. package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +4 -3
  498. package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +10 -9
  499. package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +3 -2
  500. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +2 -1
  501. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +3 -2
  502. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +2 -1
  503. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +2 -1
  504. package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +2 -1
  505. package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +3 -2
  506. package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +2 -1
  507. package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +2 -1
  508. package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +3 -2
  509. package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +2 -1
  510. package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +2 -1
  511. package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +2 -1
  512. package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +3 -2
  513. package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +2 -1
  514. package/data/packages/platform-payments/api/index.md +41 -40
  515. package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +4 -3
  516. package/data/packages/platform-reporting/api/Class.ReportingDatasetNotFoundError.md +4 -3
  517. package/data/packages/platform-reporting/api/Class.ReportingFacade.md +9 -8
  518. package/data/packages/platform-reporting/api/Class.ReportingModule.md +1 -0
  519. package/data/packages/platform-reporting/api/Interface.IReportingContributor.md +5 -4
  520. package/data/packages/platform-reporting/api/Interface.IReportingDataset.md +6 -5
  521. package/data/packages/platform-reporting/api/Interface.IReportingDatasetField.md +5 -4
  522. package/data/packages/platform-reporting/api/Interface.IReportingQuery.md +5 -4
  523. package/data/packages/platform-reporting/api/Interface.IReportingQueryFilter.md +3 -2
  524. package/data/packages/platform-reporting/api/Interface.IReportingQueryResult.md +5 -4
  525. package/data/packages/platform-reporting/api/Interface.IReportingQuerySort.md +2 -1
  526. package/data/packages/platform-reporting/api/TypeAlias.ReportingFieldType.md +2 -1
  527. package/data/packages/platform-reporting/api/TypeAlias.ReportingFilterOperator.md +2 -1
  528. package/data/packages/platform-reporting/api/TypeAlias.ReportingQueryResultRow.md +1 -0
  529. package/data/packages/platform-reporting/api/Variable.ReportingFieldTypes.md +13 -12
  530. package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +11 -10
  531. package/data/packages/platform-reporting/api/index.md +24 -23
  532. package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +23 -22
  533. package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +27 -26
  534. package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +24 -23
  535. package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +36 -35
  536. package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +3 -2
  537. package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +5 -4
  538. package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +23 -22
  539. package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +3 -2
  540. package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +9 -8
  541. package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +3 -2
  542. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +2 -1
  543. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +2 -1
  544. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +2 -1
  545. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md +2 -1
  546. package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +1 -0
  547. package/data/packages/platform-telemetry/api/index.md +21 -20
  548. package/package.json +1 -1
@@ -3,45 +3,46 @@ title: '@breadstone/archipel-platform-documents'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # @breadstone/archipel-platform-documents
7
8
 
8
9
  ## Classes
9
10
 
10
- | Class | Description |
11
- | ------ | ------ |
12
- | [BaseDocumentRenderer](Class.BaseDocumentRenderer) | Base class for document renderers. Provides common functionality for template loading, parsing, and image processing. |
13
- | [DocumentEngine](Class.DocumentEngine) | DocumentEngine orchestrates document generation workflow. Coordinates resource loading and renderer components. |
14
- | [DocumentModule](Class.DocumentModule) | DocumentModule provides services for document generation and image processing. Uses abstract base classes and interfaces for extensibility. |
15
- | [SharpImageProcessor](Class.SharpImageProcessor) | Sharp-based image processor. Handles image resizing and format conversion. |
11
+ | Class | Description |
12
+ | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
13
+ | [BaseDocumentRenderer](Class.BaseDocumentRenderer) | Base class for document renderers. Provides common functionality for template loading, parsing, and image processing. |
14
+ | [DocumentEngine](Class.DocumentEngine) | DocumentEngine orchestrates document generation workflow. Coordinates resource loading and renderer components. |
15
+ | [DocumentModule](Class.DocumentModule) | DocumentModule provides services for document generation and image processing. Uses abstract base classes and interfaces for extensibility. |
16
+ | [SharpImageProcessor](Class.SharpImageProcessor) | Sharp-based image processor. Handles image resizing and format conversion. |
16
17
 
17
18
  ## Interfaces
18
19
 
19
- | Interface | Description |
20
- | ------ | ------ |
21
- | [IDocumentModuleOptions](Interface.IDocumentModuleOptions) | Configuration options for the DocumentModule. |
22
- | [IDocumentPlaceholderDetail](Interface.IDocumentPlaceholderDetail) | Placeholder detail for document probe report. |
23
- | [IDocumentProbeReport](Interface.IDocumentProbeReport) | Document probe report. |
24
- | [IDocumentRenderer](Interface.IDocumentRenderer) | Base interface for document renderers. Each renderer handles specific document formats. |
25
- | [IImagePayload](Interface.IImagePayload) | Image payload for templates. |
26
- | [IImageProcessor](Interface.IImageProcessor) | Base interface for image processors. Handles image manipulation and format conversion. |
27
- | [IRenderOptions](Interface.IRenderOptions) | Options for rendering a document. |
28
- | [IRenderResult](Interface.IRenderResult) | Document render result. |
20
+ | Interface | Description |
21
+ | ------------------------------------------------------------------ | --------------------------------------------------------------------------------------- |
22
+ | [IDocumentModuleOptions](Interface.IDocumentModuleOptions) | Configuration options for the DocumentModule. |
23
+ | [IDocumentPlaceholderDetail](Interface.IDocumentPlaceholderDetail) | Placeholder detail for document probe report. |
24
+ | [IDocumentProbeReport](Interface.IDocumentProbeReport) | Document probe report. |
25
+ | [IDocumentRenderer](Interface.IDocumentRenderer) | Base interface for document renderers. Each renderer handles specific document formats. |
26
+ | [IImagePayload](Interface.IImagePayload) | Image payload for templates. |
27
+ | [IImageProcessor](Interface.IImageProcessor) | Base interface for image processors. Handles image manipulation and format conversion. |
28
+ | [IRenderOptions](Interface.IRenderOptions) | Options for rendering a document. |
29
+ | [IRenderResult](Interface.IRenderResult) | Document render result. |
29
30
 
30
31
  ## Type Aliases
31
32
 
32
- | Type Alias | Description |
33
- | ------ | ------ |
34
- | [DocumentFormat](TypeAlias.DocumentFormat) | Document output format types. |
35
- | [EngineType](TypeAlias.EngineType) | Template engine type. |
36
- | [ImageMimeType](TypeAlias.ImageMimeType) | Image MIME type. |
33
+ | Type Alias | Description |
34
+ | ------------------------------------------ | ------------------------------------- |
35
+ | [DocumentFormat](TypeAlias.DocumentFormat) | Document output format types. |
36
+ | [EngineType](TypeAlias.EngineType) | Template engine type. |
37
+ | [ImageMimeType](TypeAlias.ImageMimeType) | Image MIME type. |
37
38
  | [TemplateFormat](TypeAlias.TemplateFormat) | Template format type (parser syntax). |
38
- | [TemplateType](TypeAlias.TemplateType) | Template type. |
39
+ | [TemplateType](TypeAlias.TemplateType) | Template type. |
39
40
 
40
41
  ## Variables
41
42
 
42
- | Variable | Description |
43
- | ------ | ------ |
44
- | [DOCUMENT\_MODULE\_OPTIONS](Variable.DOCUMENT_MODULE_OPTIONS) | Injection token for DocumentModule options. |
45
- | [DOCUMENT\_PARSER\_TOKEN](Variable.DOCUMENT_PARSER_TOKEN) | Injection token for IDocumentParser. |
46
- | [DOCUMENT\_RENDERER\_TOKEN](Variable.DOCUMENT_RENDERER_TOKEN) | Injection token for IDocumentRenderer (multi-provider). |
47
- | [IMAGE\_PROCESSOR\_TOKEN](Variable.IMAGE_PROCESSOR_TOKEN) | Injection token for IImageProcessor. |
43
+ | Variable | Description |
44
+ | ----------------------------------------------------------- | ------------------------------------------------------- |
45
+ | [DOCUMENT_MODULE_OPTIONS](Variable.DOCUMENT_MODULE_OPTIONS) | Injection token for DocumentModule options. |
46
+ | [DOCUMENT_PARSER_TOKEN](Variable.DOCUMENT_PARSER_TOKEN) | Injection token for IDocumentParser. |
47
+ | [DOCUMENT_RENDERER_TOKEN](Variable.DOCUMENT_RENDERER_TOKEN) | Injection token for IDocumentRenderer (multi-provider). |
48
+ | [IMAGE_PROCESSOR_TOKEN](Variable.IMAGE_PROCESSOR_TOKEN) | Injection token for IImageProcessor. |
@@ -3,6 +3,7 @@ title: 'Abstract Class: EsigningClientPort'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Abstract Class: EsigningClientPort
7
8
 
8
9
  Defined in: [contracts/EsigningClientPort.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningClientPort.ts#L19)
@@ -53,16 +54,16 @@ Cancel an in-progress signing request.
53
54
 
54
55
  #### Parameters
55
56
 
56
- | Parameter | Type | Description |
57
- | ------ | ------ | ------ |
57
+ | Parameter | Type | Description |
58
+ | ------------------ | -------- | ------------------------------------------------- |
58
59
  | `signingRequestId` | `string` | The provider-specific signing request identifier. |
59
- | `reason?` | `string` | Optional reason for cancellation. |
60
+ | `reason?` | `string` | Optional reason for cancellation. |
60
61
 
61
62
  #### Returns
62
63
 
63
64
  `Promise`\<`void`\>
64
65
 
65
- ***
66
+ ---
66
67
 
67
68
  ### createSigningRequest()
68
69
 
@@ -76,8 +77,8 @@ Create a new signing request (envelope/agreement).
76
77
 
77
78
  #### Parameters
78
79
 
79
- | Parameter | Type | Description |
80
- | ------ | ------ | ------ |
80
+ | Parameter | Type | Description |
81
+ | --------- | ---------------------------------------------------------- | ----------------------------------- |
81
82
  | `request` | [`ICreateSigningRequest`](Interface.ICreateSigningRequest) | The signing request creation input. |
82
83
 
83
84
  #### Returns
@@ -86,7 +87,7 @@ Create a new signing request (envelope/agreement).
86
87
 
87
88
  The created signing request with provider-assigned identifiers.
88
89
 
89
- ***
90
+ ---
90
91
 
91
92
  ### createSigningSession()
92
93
 
@@ -100,8 +101,8 @@ Generate a signing session (signing link/URL) for a specific signer.
100
101
 
101
102
  #### Parameters
102
103
 
103
- | Parameter | Type | Description |
104
- | ------ | ------ | ------ |
104
+ | Parameter | Type | Description |
105
+ | --------- | ------------------------------------------------------------------------ | --------------------------- |
105
106
  | `request` | [`ICreateSigningSessionRequest`](Interface.ICreateSigningSessionRequest) | The session creation input. |
106
107
 
107
108
  #### Returns
@@ -110,7 +111,7 @@ Generate a signing session (signing link/URL) for a specific signer.
110
111
 
111
112
  The signing session with the signing URL.
112
113
 
113
- ***
114
+ ---
114
115
 
115
116
  ### getSignedDocuments()
116
117
 
@@ -124,8 +125,8 @@ Retrieve the final signed documents for a completed signing request.
124
125
 
125
126
  #### Parameters
126
127
 
127
- | Parameter | Type | Description |
128
- | ------ | ------ | ------ |
128
+ | Parameter | Type | Description |
129
+ | ------------------ | -------- | ------------------------------------------------- |
129
130
  | `signingRequestId` | `string` | The provider-specific signing request identifier. |
130
131
 
131
132
  #### Returns
@@ -134,7 +135,7 @@ Retrieve the final signed documents for a completed signing request.
134
135
 
135
136
  Array of signed documents with their content.
136
137
 
137
- ***
138
+ ---
138
139
 
139
140
  ### getSigningRequest()
140
141
 
@@ -148,8 +149,8 @@ Retrieve the current status and details of a signing request.
148
149
 
149
150
  #### Parameters
150
151
 
151
- | Parameter | Type | Description |
152
- | ------ | ------ | ------ |
152
+ | Parameter | Type | Description |
153
+ | ------------------ | -------- | ------------------------------------------------- |
153
154
  | `signingRequestId` | `string` | The provider-specific signing request identifier. |
154
155
 
155
156
  #### Returns
@@ -158,7 +159,7 @@ Retrieve the current status and details of a signing request.
158
159
 
159
160
  The signing request with current status.
160
161
 
161
- ***
162
+ ---
162
163
 
163
164
  ### verifyWebhook()
164
165
 
@@ -172,10 +173,10 @@ Verify a webhook payload signature and return a normalized event.
172
173
 
173
174
  #### Parameters
174
175
 
175
- | Parameter | Type | Description |
176
- | ------ | ------ | ------ |
177
- | `payload` | `string` \| `Buffer`\<`ArrayBufferLike`\> | Raw webhook body. |
178
- | `signature` | `string` | Webhook signature header value. |
176
+ | Parameter | Type | Description |
177
+ | ----------- | ----------------------------------------- | ------------------------------- |
178
+ | `payload` | `string` \| `Buffer`\<`ArrayBufferLike`\> | Raw webhook body. |
179
+ | `signature` | `string` | Webhook signature header value. |
179
180
 
180
181
  #### Returns
181
182
 
@@ -3,6 +3,7 @@ title: 'Class: EsigningError'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Class: EsigningError
7
8
 
8
9
  Defined in: [errors/EsigningError.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/errors/EsigningError.ts#L6)
@@ -31,10 +32,10 @@ Defined in: [errors/EsigningError.ts:15](https://github.com/RueDeRennes/archipel
31
32
 
32
33
  #### Parameters
33
34
 
34
- | Parameter | Type |
35
- | ------ | ------ |
35
+ | Parameter | Type |
36
+ | --------- | -------- |
36
37
  | `message` | `string` |
37
- | `code` | `string` |
38
+ | `code` | `string` |
38
39
 
39
40
  #### Returns
40
41
 
@@ -43,7 +44,7 @@ Defined in: [errors/EsigningError.ts:15](https://github.com/RueDeRennes/archipel
43
44
  #### Overrides
44
45
 
45
46
  ```ts
46
- Error.constructor
47
+ Error.constructor;
47
48
  ```
48
49
 
49
50
  ## Accessors
@@ -3,6 +3,7 @@ title: 'Class: EsigningModule'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Class: EsigningModule
7
8
 
8
9
  Defined in: [EsigningModule.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L52)
@@ -37,8 +38,8 @@ Configures the module with the specified options.
37
38
 
38
39
  #### Parameters
39
40
 
40
- | Parameter | Type | Description |
41
- | ------ | ------ | ------ |
41
+ | Parameter | Type | Description |
42
+ | --------- | ------------------------------------------------------------ | --------------------------------- |
42
43
  | `options` | [`IEsigningModuleOptions`](Interface.IEsigningModuleOptions) | The module configuration options. |
43
44
 
44
45
  #### Returns
@@ -3,6 +3,7 @@ title: 'Abstract Class: EsigningPersistencePort'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Abstract Class: EsigningPersistencePort
7
8
 
8
9
  Defined in: [contracts/EsigningPersistencePort.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningPersistencePort.ts#L13)
@@ -36,15 +37,15 @@ Update persisted state when a signing request is cancelled.
36
37
 
37
38
  #### Parameters
38
39
 
39
- | Parameter | Type | Description |
40
- | ------ | ------ | ------ |
40
+ | Parameter | Type | Description |
41
+ | ------------------ | -------- | ------------------------------------------------- |
41
42
  | `signingRequestId` | `string` | The provider-specific signing request identifier. |
42
43
 
43
44
  #### Returns
44
45
 
45
46
  `Promise`\<`void`\>
46
47
 
47
- ***
48
+ ---
48
49
 
49
50
  ### onSigningRequestCreated()
50
51
 
@@ -58,15 +59,15 @@ Persist a newly created signing request.
58
59
 
59
60
  #### Parameters
60
61
 
61
- | Parameter | Type | Description |
62
- | ------ | ------ | ------ |
62
+ | Parameter | Type | Description |
63
+ | ---------------- | ---------------------------------------------- | ------------------------------- |
63
64
  | `signingRequest` | [`ISigningRequest`](Interface.ISigningRequest) | The signing request to persist. |
64
65
 
65
66
  #### Returns
66
67
 
67
68
  `Promise`\<`void`\>
68
69
 
69
- ***
70
+ ---
70
71
 
71
72
  ### onSigningRequestStatusChanged()
72
73
 
@@ -80,10 +81,10 @@ Update persisted state when a signing request status changes.
80
81
 
81
82
  #### Parameters
82
83
 
83
- | Parameter | Type | Description |
84
- | ------ | ------ | ------ |
84
+ | Parameter | Type | Description |
85
+ | ------------------ | -------- | ------------------------------------------------- |
85
86
  | `signingRequestId` | `string` | The provider-specific signing request identifier. |
86
- | `status` | `string` | The new status of the signing request. |
87
+ | `status` | `string` | The new status of the signing request. |
87
88
 
88
89
  #### Returns
89
90
 
@@ -3,6 +3,7 @@ title: 'Class: EsigningService'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Class: EsigningService
7
8
 
8
9
  Defined in: [services/EsigningService.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/services/EsigningService.ts#L23)
@@ -25,9 +26,9 @@ Initializes a new instance of the EsigningService class.
25
26
 
26
27
  #### Parameters
27
28
 
28
- | Parameter | Type | Description |
29
- | ------ | ------ | ------ |
30
- | `client` | [`EsigningClientPort`](Class.EsigningClientPort) | The concrete e-signing provider implementation. |
29
+ | Parameter | Type | Description |
30
+ | ------------- | -------------------------------------------------------------------- | --------------------------------------------------- |
31
+ | `client` | [`EsigningClientPort`](Class.EsigningClientPort) | The concrete e-signing provider implementation. |
31
32
  | `persistence` | [`EsigningPersistencePort`](Class.EsigningPersistencePort) \| `null` | Optional port for persisting signing request state. |
32
33
 
33
34
  #### Returns
@@ -66,16 +67,16 @@ Cancel an in-progress signing request.
66
67
 
67
68
  #### Parameters
68
69
 
69
- | Parameter | Type | Description |
70
- | ------ | ------ | ------ |
71
- | `signingRequestId` | `string` | The signing request identifier. |
72
- | `reason?` | `string` | Optional reason for cancellation. |
70
+ | Parameter | Type | Description |
71
+ | ------------------ | -------- | --------------------------------- |
72
+ | `signingRequestId` | `string` | The signing request identifier. |
73
+ | `reason?` | `string` | Optional reason for cancellation. |
73
74
 
74
75
  #### Returns
75
76
 
76
77
  `Promise`\<`void`\>
77
78
 
78
- ***
79
+ ---
79
80
 
80
81
  ### createSigningRequest()
81
82
 
@@ -89,8 +90,8 @@ Create a new signing request.
89
90
 
90
91
  #### Parameters
91
92
 
92
- | Parameter | Type | Description |
93
- | ------ | ------ | ------ |
93
+ | Parameter | Type | Description |
94
+ | --------- | ---------------------------------------------------------- | ----------------------------------- |
94
95
  | `request` | [`ICreateSigningRequest`](Interface.ICreateSigningRequest) | The signing request creation input. |
95
96
 
96
97
  #### Returns
@@ -99,7 +100,7 @@ Create a new signing request.
99
100
 
100
101
  The created signing request.
101
102
 
102
- ***
103
+ ---
103
104
 
104
105
  ### createSigningSession()
105
106
 
@@ -113,8 +114,8 @@ Generate a signing session (signing link) for a specific signer.
113
114
 
114
115
  #### Parameters
115
116
 
116
- | Parameter | Type | Description |
117
- | ------ | ------ | ------ |
117
+ | Parameter | Type | Description |
118
+ | --------- | ------------------------------------------------------------------------ | --------------------------- |
118
119
  | `request` | [`ICreateSigningSessionRequest`](Interface.ICreateSigningSessionRequest) | The session creation input. |
119
120
 
120
121
  #### Returns
@@ -123,7 +124,7 @@ Generate a signing session (signing link) for a specific signer.
123
124
 
124
125
  The signing session.
125
126
 
126
- ***
127
+ ---
127
128
 
128
129
  ### getSignedDocuments()
129
130
 
@@ -137,8 +138,8 @@ Retrieve the final signed documents for a completed signing request.
137
138
 
138
139
  #### Parameters
139
140
 
140
- | Parameter | Type | Description |
141
- | ------ | ------ | ------ |
141
+ | Parameter | Type | Description |
142
+ | ------------------ | -------- | ------------------------------- |
142
143
  | `signingRequestId` | `string` | The signing request identifier. |
143
144
 
144
145
  #### Returns
@@ -147,7 +148,7 @@ Retrieve the final signed documents for a completed signing request.
147
148
 
148
149
  Array of signed documents.
149
150
 
150
- ***
151
+ ---
151
152
 
152
153
  ### getSigningRequest()
153
154
 
@@ -161,8 +162,8 @@ Retrieve the current status and details of a signing request.
161
162
 
162
163
  #### Parameters
163
164
 
164
- | Parameter | Type | Description |
165
- | ------ | ------ | ------ |
165
+ | Parameter | Type | Description |
166
+ | ------------------ | -------- | ------------------------------- |
166
167
  | `signingRequestId` | `string` | The signing request identifier. |
167
168
 
168
169
  #### Returns
@@ -171,7 +172,7 @@ Retrieve the current status and details of a signing request.
171
172
 
172
173
  The signing request with current status.
173
174
 
174
- ***
175
+ ---
175
176
 
176
177
  ### verifyWebhook()
177
178
 
@@ -186,10 +187,10 @@ Optionally updates persistence if a state change is detected.
186
187
 
187
188
  #### Parameters
188
189
 
189
- | Parameter | Type | Description |
190
- | ------ | ------ | ------ |
191
- | `payload` | `string` \| `Buffer`\<`ArrayBufferLike`\> | Raw webhook body. |
192
- | `signature` | `string` | Webhook signature header value. |
190
+ | Parameter | Type | Description |
191
+ | ----------- | ----------------------------------------- | ------------------------------- |
192
+ | `payload` | `string` \| `Buffer`\<`ArrayBufferLike`\> | Raw webhook body. |
193
+ | `signature` | `string` | Webhook signature header value. |
193
194
 
194
195
  #### Returns
195
196
 
@@ -3,6 +3,7 @@ title: 'Class: InternalEsigningProvider'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Class: InternalEsigningProvider
7
8
 
8
9
  Defined in: [providers/internal/InternalEsigningProvider.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/providers/internal/InternalEsigningProvider.ts#L42)
@@ -69,10 +70,10 @@ Cancel an in-progress signing request.
69
70
 
70
71
  #### Parameters
71
72
 
72
- | Parameter | Type | Description |
73
- | ------ | ------ | ------ |
73
+ | Parameter | Type | Description |
74
+ | ------------------ | -------- | ------------------------------------------------- |
74
75
  | `signingRequestId` | `string` | The provider-specific signing request identifier. |
75
- | `_reason?` | `string` | - |
76
+ | `_reason?` | `string` | - |
76
77
 
77
78
  #### Returns
78
79
 
@@ -82,7 +83,7 @@ Cancel an in-progress signing request.
82
83
 
83
84
  [`EsigningClientPort`](Class.EsigningClientPort).[`cancelSigningRequest`](Class.EsigningClientPort#cancelsigningrequest)
84
85
 
85
- ***
86
+ ---
86
87
 
87
88
  ### completeSigner()
88
89
 
@@ -98,16 +99,16 @@ application to programmatically complete a signer's step.
98
99
 
99
100
  #### Parameters
100
101
 
101
- | Parameter | Type | Description |
102
- | ------ | ------ | ------ |
102
+ | Parameter | Type | Description |
103
+ | ------------------ | -------- | ------------------------------- |
103
104
  | `signingRequestId` | `string` | The signing request identifier. |
104
- | `signerId` | `string` | The signer identifier. |
105
+ | `signerId` | `string` | The signer identifier. |
105
106
 
106
107
  #### Returns
107
108
 
108
109
  `Promise`\<`void`\>
109
110
 
110
- ***
111
+ ---
111
112
 
112
113
  ### createSigningRequest()
113
114
 
@@ -121,8 +122,8 @@ Create a new signing request (envelope/agreement).
121
122
 
122
123
  #### Parameters
123
124
 
124
- | Parameter | Type | Description |
125
- | ------ | ------ | ------ |
125
+ | Parameter | Type | Description |
126
+ | --------- | ---------------------------------------------------------- | ----------------------------------- |
126
127
  | `request` | [`ICreateSigningRequest`](Interface.ICreateSigningRequest) | The signing request creation input. |
127
128
 
128
129
  #### Returns
@@ -135,7 +136,7 @@ The created signing request with provider-assigned identifiers.
135
136
 
136
137
  [`EsigningClientPort`](Class.EsigningClientPort).[`createSigningRequest`](Class.EsigningClientPort#createsigningrequest)
137
138
 
138
- ***
139
+ ---
139
140
 
140
141
  ### createSigningSession()
141
142
 
@@ -149,8 +150,8 @@ Generate a signing session (signing link/URL) for a specific signer.
149
150
 
150
151
  #### Parameters
151
152
 
152
- | Parameter | Type | Description |
153
- | ------ | ------ | ------ |
153
+ | Parameter | Type | Description |
154
+ | --------- | ------------------------------------------------------------------------ | --------------------------- |
154
155
  | `request` | [`ICreateSigningSessionRequest`](Interface.ICreateSigningSessionRequest) | The session creation input. |
155
156
 
156
157
  #### Returns
@@ -163,7 +164,7 @@ The signing session with the signing URL.
163
164
 
164
165
  [`EsigningClientPort`](Class.EsigningClientPort).[`createSigningSession`](Class.EsigningClientPort#createsigningsession)
165
166
 
166
- ***
167
+ ---
167
168
 
168
169
  ### getSignedDocuments()
169
170
 
@@ -177,8 +178,8 @@ Retrieve the final signed documents for a completed signing request.
177
178
 
178
179
  #### Parameters
179
180
 
180
- | Parameter | Type | Description |
181
- | ------ | ------ | ------ |
181
+ | Parameter | Type | Description |
182
+ | ------------------ | -------- | ------------------------------------------------- |
182
183
  | `signingRequestId` | `string` | The provider-specific signing request identifier. |
183
184
 
184
185
  #### Returns
@@ -191,7 +192,7 @@ Array of signed documents with their content.
191
192
 
192
193
  [`EsigningClientPort`](Class.EsigningClientPort).[`getSignedDocuments`](Class.EsigningClientPort#getsigneddocuments)
193
194
 
194
- ***
195
+ ---
195
196
 
196
197
  ### getSigningRequest()
197
198
 
@@ -205,8 +206,8 @@ Retrieve the current status and details of a signing request.
205
206
 
206
207
  #### Parameters
207
208
 
208
- | Parameter | Type | Description |
209
- | ------ | ------ | ------ |
209
+ | Parameter | Type | Description |
210
+ | ------------------ | -------- | ------------------------------------------------- |
210
211
  | `signingRequestId` | `string` | The provider-specific signing request identifier. |
211
212
 
212
213
  #### Returns
@@ -219,7 +220,7 @@ The signing request with current status.
219
220
 
220
221
  [`EsigningClientPort`](Class.EsigningClientPort).[`getSigningRequest`](Class.EsigningClientPort#getsigningrequest)
221
222
 
222
- ***
223
+ ---
223
224
 
224
225
  ### verifyWebhook()
225
226
 
@@ -233,10 +234,10 @@ Verify a webhook payload signature and return a normalized event.
233
234
 
234
235
  #### Parameters
235
236
 
236
- | Parameter | Type |
237
- | ------ | ------ |
238
- | `_payload` | `string` \| `Buffer`\<`ArrayBufferLike`\> |
239
- | `_signature` | `string` |
237
+ | Parameter | Type |
238
+ | ------------ | ----------------------------------------- |
239
+ | `_payload` | `string` \| `Buffer`\<`ArrayBufferLike`\> |
240
+ | `_signature` | `string` |
240
241
 
241
242
  #### Returns
242
243
 
@@ -3,6 +3,7 @@ title: 'Class: SigningProviderError'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Class: SigningProviderError
7
8
 
8
9
  Defined in: [errors/SigningProviderError.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/errors/SigningProviderError.ts#L12)
@@ -19,8 +20,8 @@ Thrown when a provider-level operation fails.
19
20
 
20
21
  ```ts
21
22
  new SigningProviderError(
22
- providerId,
23
- message,
23
+ providerId,
24
+ message,
24
25
  cause?): SigningProviderError;
25
26
  ```
26
27
 
@@ -28,11 +29,11 @@ Defined in: [errors/SigningProviderError.ts:22](https://github.com/RueDeRennes/a
28
29
 
29
30
  #### Parameters
30
31
 
31
- | Parameter | Type |
32
- | ------ | ------ |
33
- | `providerId` | `string` |
34
- | `message` | `string` |
35
- | `cause?` | `unknown` |
32
+ | Parameter | Type |
33
+ | ------------ | --------- |
34
+ | `providerId` | `string` |
35
+ | `message` | `string` |
36
+ | `cause?` | `unknown` |
36
37
 
37
38
  #### Returns
38
39
 
@@ -64,7 +65,7 @@ Machine-readable error code.
64
65
 
65
66
  [`EsigningError`](Class.EsigningError).[`code`](Class.EsigningError#code)
66
67
 
67
- ***
68
+ ---
68
69
 
69
70
  ### providerId
70
71
 
@@ -82,7 +83,7 @@ Identifier of the provider that failed.
82
83
 
83
84
  `string`
84
85
 
85
- ***
86
+ ---
86
87
 
87
88
  ### rootCause
88
89
 
@@ -3,6 +3,7 @@ title: 'Class: SigningRequestNotFoundError'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
+
6
7
  # Class: SigningRequestNotFoundError
7
8
 
8
9
  Defined in: [errors/SigningRequestNotFoundError.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/errors/SigningRequestNotFoundError.ts#L12)
@@ -25,8 +26,8 @@ Defined in: [errors/SigningRequestNotFoundError.ts:21](https://github.com/RueDeR
25
26
 
26
27
  #### Parameters
27
28
 
28
- | Parameter | Type |
29
- | ------ | ------ |
29
+ | Parameter | Type |
30
+ | ------------------ | -------- |
30
31
  | `signingRequestId` | `string` |
31
32
 
32
33
  #### Returns
@@ -59,7 +60,7 @@ Machine-readable error code.
59
60
 
60
61
  [`EsigningError`](Class.EsigningError).[`code`](Class.EsigningError#code)
61
62
 
62
- ***
63
+ ---
63
64
 
64
65
  ### signingRequestId
65
66