@breadstone/archipel-mcp 0.0.1

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 (347) hide show
  1. package/README.md +80 -0
  2. package/data/packages/index.md +42 -0
  3. package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +45 -0
  4. package/data/packages/platform-authentication/api/Class.AuthModule.md +72 -0
  5. package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +100 -0
  6. package/data/packages/platform-authentication/api/Class.AuthTokenService.md +64 -0
  7. package/data/packages/platform-authentication/api/Class.ChallengeService.md +136 -0
  8. package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +45 -0
  9. package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +45 -0
  10. package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +116 -0
  11. package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +76 -0
  12. package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +45 -0
  13. package/data/packages/platform-authentication/api/Class.MfaService.md +257 -0
  14. package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +75 -0
  15. package/data/packages/platform-authentication/api/Class.RolesGuard.md +65 -0
  16. package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +65 -0
  17. package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +170 -0
  18. package/data/packages/platform-authentication/api/Class.SessionResponse.md +157 -0
  19. package/data/packages/platform-authentication/api/Class.SessionService.md +167 -0
  20. package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +66 -0
  21. package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +53 -0
  22. package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +52 -0
  23. package/data/packages/platform-authentication/api/Class.VerificationService.md +159 -0
  24. package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +121 -0
  25. package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +89 -0
  26. package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +112 -0
  27. package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +87 -0
  28. package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +123 -0
  29. package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +27 -0
  30. package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +63 -0
  31. package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +136 -0
  32. package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +96 -0
  33. package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +165 -0
  34. package/data/packages/platform-authentication/api/Interface.ISignInResult.md +87 -0
  35. package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +63 -0
  36. package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +75 -0
  37. package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +76 -0
  38. package/data/packages/platform-authentication/api/_media/ENVIRONMENT_VARIABLES.md +151 -0
  39. package/data/packages/platform-authentication/api/index.md +508 -0
  40. package/data/packages/platform-authentication/index.md +635 -0
  41. package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +84 -0
  42. package/data/packages/platform-blob-storage/api/Class.BlobModule.md +54 -0
  43. package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +80 -0
  44. package/data/packages/platform-blob-storage/api/Class.BlobService.md +253 -0
  45. package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +56 -0
  46. package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +202 -0
  47. package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +43 -0
  48. package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +53 -0
  49. package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +69 -0
  50. package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +53 -0
  51. package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +143 -0
  52. package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +119 -0
  53. package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +53 -0
  54. package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +103 -0
  55. package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +33 -0
  56. package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +33 -0
  57. package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +73 -0
  58. package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +33 -0
  59. package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +17 -0
  60. package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +17 -0
  61. package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +17 -0
  62. package/data/packages/platform-blob-storage/api/index.md +111 -0
  63. package/data/packages/platform-blob-storage/index.md +280 -0
  64. package/data/packages/platform-core/api/Class.AppHealthIndicator.md +51 -0
  65. package/data/packages/platform-core/api/Class.BcryptService.md +69 -0
  66. package/data/packages/platform-core/api/Class.BlobResourceStrategy.md +196 -0
  67. package/data/packages/platform-core/api/Class.BooleanUtils.md +83 -0
  68. package/data/packages/platform-core/api/Class.CUIDGenerator.md +121 -0
  69. package/data/packages/platform-core/api/Class.CasingInterceptor.md +84 -0
  70. package/data/packages/platform-core/api/Class.CatchUtils.md +94 -0
  71. package/data/packages/platform-core/api/Class.ConfigModule.md +70 -0
  72. package/data/packages/platform-core/api/Class.ConfigRegistry.md +116 -0
  73. package/data/packages/platform-core/api/Class.ConfigService.md +139 -0
  74. package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +110 -0
  75. package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +64 -0
  76. package/data/packages/platform-core/api/Class.CryptoService.md +50 -0
  77. package/data/packages/platform-core/api/Class.DateTimeUtils.md +102 -0
  78. package/data/packages/platform-core/api/Class.DeviceParserService.md +53 -0
  79. package/data/packages/platform-core/api/Class.EmbeddedResourceStrategy.md +216 -0
  80. package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +144 -0
  81. package/data/packages/platform-core/api/Class.ErrorTemplateService.md +110 -0
  82. package/data/packages/platform-core/api/Class.EventHub.md +164 -0
  83. package/data/packages/platform-core/api/Class.EventModule.md +23 -0
  84. package/data/packages/platform-core/api/Class.FileConfigStrategy.md +150 -0
  85. package/data/packages/platform-core/api/Class.FileResourceStrategy.md +193 -0
  86. package/data/packages/platform-core/api/Class.GUIDGenerator.md +86 -0
  87. package/data/packages/platform-core/api/Class.GlobalExceptionFilter.md +67 -0
  88. package/data/packages/platform-core/api/Class.HealthModule.md +43 -0
  89. package/data/packages/platform-core/api/Class.HealthOrchestrator.md +65 -0
  90. package/data/packages/platform-core/api/Class.HostModule.md +33 -0
  91. package/data/packages/platform-core/api/Class.HostService.md +150 -0
  92. package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md +60 -0
  93. package/data/packages/platform-core/api/Class.IdGeneratorBase.md +88 -0
  94. package/data/packages/platform-core/api/Class.IdentifierModule.md +41 -0
  95. package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistrarBase.md +39 -0
  96. package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistry.md +103 -0
  97. package/data/packages/platform-core/api/Class.IntelligenceModule.md +23 -0
  98. package/data/packages/platform-core/api/Class.IntelligenceTextGenerator.md +82 -0
  99. package/data/packages/platform-core/api/Class.LimitRequestSizeMiddleware.md +60 -0
  100. package/data/packages/platform-core/api/Class.LocalizedTextRequest.md +43 -0
  101. package/data/packages/platform-core/api/Class.LocalizedTextResponse.md +43 -0
  102. package/data/packages/platform-core/api/Class.MappingBuilder.md +111 -0
  103. package/data/packages/platform-core/api/Class.MappingModule.md +47 -0
  104. package/data/packages/platform-core/api/Class.MappingNotRegisteredError.md +57 -0
  105. package/data/packages/platform-core/api/Class.MappingProfileBase.md +53 -0
  106. package/data/packages/platform-core/api/Class.MappingService.md +285 -0
  107. package/data/packages/platform-core/api/Class.MemoryLayeredCache.md +251 -0
  108. package/data/packages/platform-core/api/Class.NoopCacheMetricsRecorder.md +157 -0
  109. package/data/packages/platform-core/api/Class.NormalizedUtils.md +149 -0
  110. package/data/packages/platform-core/api/Class.OtpService.md +106 -0
  111. package/data/packages/platform-core/api/Class.PageableRequest.md +43 -0
  112. package/data/packages/platform-core/api/Class.PageableResponse.md +63 -0
  113. package/data/packages/platform-core/api/Class.ProblemDetailException.md +62 -0
  114. package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +85 -0
  115. package/data/packages/platform-core/api/Class.QuantityResponse.md +43 -0
  116. package/data/packages/platform-core/api/Class.RedisLayeredCache.md +275 -0
  117. package/data/packages/platform-core/api/Class.ResourceManager.md +566 -0
  118. package/data/packages/platform-core/api/Class.ResourceModule.md +47 -0
  119. package/data/packages/platform-core/api/Class.ResponseReturn.md +504 -0
  120. package/data/packages/platform-core/api/Class.SseHub.md +184 -0
  121. package/data/packages/platform-core/api/Class.SseModule.md +43 -0
  122. package/data/packages/platform-core/api/Class.TimeStampResponse.md +43 -0
  123. package/data/packages/platform-core/api/Class.TypeMappingNotRegisteredError.md +58 -0
  124. package/data/packages/platform-core/api/Class.UUIDGenerator.md +86 -0
  125. package/data/packages/platform-core/api/Class.UserAvatarGeneratorService.md +48 -0
  126. package/data/packages/platform-core/api/Class.UserNameGeneratorService.md +65 -0
  127. package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md +29 -0
  128. package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md +41 -0
  129. package/data/packages/platform-core/api/Interface.ICacheMetricsRecorder.md +121 -0
  130. package/data/packages/platform-core/api/Interface.ICacheStats.md +71 -0
  131. package/data/packages/platform-core/api/Interface.IConfigKey.md +64 -0
  132. package/data/packages/platform-core/api/Interface.IConfigModuleOptions.md +41 -0
  133. package/data/packages/platform-core/api/Interface.IConfigRegistryEntry.md +80 -0
  134. package/data/packages/platform-core/api/Interface.IDeviceInfo.md +81 -0
  135. package/data/packages/platform-core/api/Interface.IErrorPageParams.md +154 -0
  136. package/data/packages/platform-core/api/Interface.IEventKey.md +58 -0
  137. package/data/packages/platform-core/api/Interface.IEventMap.md +17 -0
  138. package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md +73 -0
  139. package/data/packages/platform-core/api/Interface.IHealthCheckResult.md +47 -0
  140. package/data/packages/platform-core/api/Interface.IHealthIndicator.md +42 -0
  141. package/data/packages/platform-core/api/Interface.IHostContentParams.md +233 -0
  142. package/data/packages/platform-core/api/Interface.IIdGenerator.md +58 -0
  143. package/data/packages/platform-core/api/Interface.IIntelligenceArtifact.md +31 -0
  144. package/data/packages/platform-core/api/Interface.IIntelligenceCapability.md +62 -0
  145. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityMetadata.md +61 -0
  146. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityPayload.md +41 -0
  147. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityRegistry.md +69 -0
  148. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityResult.md +41 -0
  149. package/data/packages/platform-core/api/Interface.IIntelligenceCompletionUsage.md +41 -0
  150. package/data/packages/platform-core/api/Interface.IIntelligenceContext.md +63 -0
  151. package/data/packages/platform-core/api/Interface.IIntelligenceContextBuilder.md +32 -0
  152. package/data/packages/platform-core/api/Interface.IIntelligenceConversationMessageSnapshot.md +61 -0
  153. package/data/packages/platform-core/api/Interface.IIntelligenceConversationSnapshot.md +51 -0
  154. package/data/packages/platform-core/api/Interface.IIntelligenceFollowUpQuestion.md +41 -0
  155. package/data/packages/platform-core/api/Interface.IIntelligenceIntent.md +41 -0
  156. package/data/packages/platform-core/api/Interface.IIntelligenceIntentEntity.md +31 -0
  157. package/data/packages/platform-core/api/Interface.IIntelligenceMessageModel.md +61 -0
  158. package/data/packages/platform-core/api/Interface.IIntelligenceMessagePayload.md +31 -0
  159. package/data/packages/platform-core/api/Interface.IIntelligencePrompt.md +31 -0
  160. package/data/packages/platform-core/api/Interface.IIntelligencePromptMessage.md +31 -0
  161. package/data/packages/platform-core/api/Interface.IIntelligenceProviderConfiguration.md +81 -0
  162. package/data/packages/platform-core/api/Interface.IIntelligenceResponseMessage.md +31 -0
  163. package/data/packages/platform-core/api/Interface.IIntelligenceTextCompletion.md +53 -0
  164. package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerationOptions.md +41 -0
  165. package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerator.md +46 -0
  166. package/data/packages/platform-core/api/Interface.ILayeredCache.md +194 -0
  167. package/data/packages/platform-core/api/Interface.ILayeredCacheOptions.md +71 -0
  168. package/data/packages/platform-core/api/Interface.IMappingBuilder.md +77 -0
  169. package/data/packages/platform-core/api/Interface.IMappingKey.md +59 -0
  170. package/data/packages/platform-core/api/Interface.IMappingProfile.md +33 -0
  171. package/data/packages/platform-core/api/Interface.IOtpService.md +78 -0
  172. package/data/packages/platform-core/api/Interface.IOtpUriOptions.md +47 -0
  173. package/data/packages/platform-core/api/Interface.IRedisLayeredCacheOptions.md +108 -0
  174. package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +72 -0
  175. package/data/packages/platform-core/api/Interface.IResourceMetadata.md +95 -0
  176. package/data/packages/platform-core/api/Interface.IResourceResult.md +35 -0
  177. package/data/packages/platform-core/api/Interface.IResourceStrategy.md +135 -0
  178. package/data/packages/platform-core/api/Interface.ISseEventData.md +37 -0
  179. package/data/packages/platform-core/api/Interface.ISseHub.md +92 -0
  180. package/data/packages/platform-core/api/Namespace.ISseEventData.md +34 -0
  181. package/data/packages/platform-core/api/TypeAlias.CamelCase.md +19 -0
  182. package/data/packages/platform-core/api/TypeAlias.IntelligenceConversationMessageRole.md +16 -0
  183. package/data/packages/platform-core/api/TypeAlias.IntelligenceProviderName.md +15 -0
  184. package/data/packages/platform-core/api/TypeAlias.ProblemDetail.md +29 -0
  185. package/data/packages/platform-core/api/TypeAlias.ProblemDetailTypeUrlResolver.md +26 -0
  186. package/data/packages/platform-core/api/TypeAlias.SetOptional.md +22 -0
  187. package/data/packages/platform-core/api/TypeAlias.StringValue.md +13 -0
  188. package/data/packages/platform-core/api/index.md +645 -0
  189. package/data/packages/platform-core/index.md +483 -0
  190. package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +80 -0
  191. package/data/packages/platform-database/api/Class.DatabaseModule.md +75 -0
  192. package/data/packages/platform-database/api/Class.DatabaseService.md +165 -0
  193. package/data/packages/platform-database/api/Class.PrismaService.md +116 -0
  194. package/data/packages/platform-database/api/Class.RepositoryBase.md +526 -0
  195. package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +60 -0
  196. package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +27 -0
  197. package/data/packages/platform-database/api/Interface.IPaginateOptions.md +33 -0
  198. package/data/packages/platform-database/api/Interface.IPaginatedResult.md +82 -0
  199. package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +56 -0
  200. package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +55 -0
  201. package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +23 -0
  202. package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +23 -0
  203. package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +36 -0
  204. package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +32 -0
  205. package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +31 -0
  206. package/data/packages/platform-database/api/index.md +183 -0
  207. package/data/packages/platform-database/index.md +300 -0
  208. package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +103 -0
  209. package/data/packages/platform-documents/api/Class.DocumentEngine.md +85 -0
  210. package/data/packages/platform-documents/api/Class.DocumentModule.md +52 -0
  211. package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +136 -0
  212. package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +100 -0
  213. package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +75 -0
  214. package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +123 -0
  215. package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +52 -0
  216. package/data/packages/platform-documents/api/Interface.IImagePayload.md +63 -0
  217. package/data/packages/platform-documents/api/Interface.IImageProcessor.md +100 -0
  218. package/data/packages/platform-documents/api/Interface.IRenderOptions.md +69 -0
  219. package/data/packages/platform-documents/api/Interface.IRenderResult.md +63 -0
  220. package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +19 -0
  221. package/data/packages/platform-documents/api/TypeAlias.EngineType.md +19 -0
  222. package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +19 -0
  223. package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +19 -0
  224. package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +19 -0
  225. package/data/packages/platform-documents/api/index.md +91 -0
  226. package/data/packages/platform-documents/index.md +219 -0
  227. package/data/packages/platform-logging/api/Class.AnalyticsService.md +113 -0
  228. package/data/packages/platform-logging/api/Class.LoggerModule.md +25 -0
  229. package/data/packages/platform-logging/api/index.md +42 -0
  230. package/data/packages/platform-logging/index.md +92 -0
  231. package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +67 -0
  232. package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +55 -0
  233. package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +65 -0
  234. package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +82 -0
  235. package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +83 -0
  236. package/data/packages/platform-mailing/api/Class.MailModule.md +27 -0
  237. package/data/packages/platform-mailing/api/Class.MailService.md +101 -0
  238. package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +98 -0
  239. package/data/packages/platform-mailing/api/Class.MailVerificationService.md +90 -0
  240. package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +82 -0
  241. package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +82 -0
  242. package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +82 -0
  243. package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +82 -0
  244. package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +82 -0
  245. package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +42 -0
  246. package/data/packages/platform-mailing/api/Interface.IMailEvents.md +71 -0
  247. package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +35 -0
  248. package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +19 -0
  249. package/data/packages/platform-mailing/api/index.md +404 -0
  250. package/data/packages/platform-mailing/index.md +335 -0
  251. package/data/packages/platform-mcp/api/Class.McpDiscoveryService.md +65 -0
  252. package/data/packages/platform-mcp/api/Class.McpModule.md +83 -0
  253. package/data/packages/platform-mcp/api/Class.McpRegistryService.md +147 -0
  254. package/data/packages/platform-mcp/api/Class.McpServerService.md +197 -0
  255. package/data/packages/platform-mcp/api/Interface.IMcpHandlerMetadata.md +47 -0
  256. package/data/packages/platform-mcp/api/Interface.IMcpModuleAsyncOptions.md +76 -0
  257. package/data/packages/platform-mcp/api/Interface.IMcpModuleOptions.md +126 -0
  258. package/data/packages/platform-mcp/api/Interface.IMcpModuleOptionsFactory.md +28 -0
  259. package/data/packages/platform-mcp/api/Interface.IMcpPromptMetadata.md +59 -0
  260. package/data/packages/platform-mcp/api/Interface.IMcpResourceMetadata.md +73 -0
  261. package/data/packages/platform-mcp/api/Interface.IMcpToolMetadata.md +83 -0
  262. package/data/packages/platform-mcp/api/Interface.IRegisteredPrompt.md +41 -0
  263. package/data/packages/platform-mcp/api/Interface.IRegisteredResource.md +41 -0
  264. package/data/packages/platform-mcp/api/Interface.IRegisteredTool.md +41 -0
  265. package/data/packages/platform-mcp/api/Interface.ISseTransportOptions.md +23 -0
  266. package/data/packages/platform-mcp/api/Interface.IStreamableHttpTransportOptions.md +39 -0
  267. package/data/packages/platform-mcp/api/index.md +123 -0
  268. package/data/packages/platform-mcp/index.md +299 -0
  269. package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +71 -0
  270. package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +104 -0
  271. package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +82 -0
  272. package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +51 -0
  273. package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +73 -0
  274. package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +73 -0
  275. package/data/packages/platform-openapi/api/index.md +209 -0
  276. package/data/packages/platform-openapi/index.md +170 -0
  277. package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +79 -0
  278. package/data/packages/platform-payments/api/Class.FeatureGuard.md +73 -0
  279. package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +74 -0
  280. package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +168 -0
  281. package/data/packages/platform-payments/api/Class.MollieClient.md +168 -0
  282. package/data/packages/platform-payments/api/Class.PaddleClient.md +168 -0
  283. package/data/packages/platform-payments/api/Class.PaymentClientPort.md +147 -0
  284. package/data/packages/platform-payments/api/Class.PaymentModule.md +53 -0
  285. package/data/packages/platform-payments/api/Class.StripeClient.md +168 -0
  286. package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +75 -0
  287. package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +75 -0
  288. package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +85 -0
  289. package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +105 -0
  290. package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +89 -0
  291. package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +65 -0
  292. package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +27 -0
  293. package/data/packages/platform-payments/api/index.md +243 -0
  294. package/data/packages/platform-payments/index.md +532 -0
  295. package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +57 -0
  296. package/data/packages/platform-reporting/api/Class.ReportingDatasetNotFoundError.md +41 -0
  297. package/data/packages/platform-reporting/api/Class.ReportingFacade.md +85 -0
  298. package/data/packages/platform-reporting/api/Class.ReportingModule.md +23 -0
  299. package/data/packages/platform-reporting/api/Interface.IReportingContributor.md +62 -0
  300. package/data/packages/platform-reporting/api/Interface.IReportingDataset.md +83 -0
  301. package/data/packages/platform-reporting/api/Interface.IReportingDatasetField.md +71 -0
  302. package/data/packages/platform-reporting/api/Interface.IReportingQuery.md +61 -0
  303. package/data/packages/platform-reporting/api/Interface.IReportingQueryFilter.md +41 -0
  304. package/data/packages/platform-reporting/api/Interface.IReportingQueryResult.md +61 -0
  305. package/data/packages/platform-reporting/api/Interface.IReportingQuerySort.md +31 -0
  306. package/data/packages/platform-reporting/api/TypeAlias.ReportingFieldType.md +13 -0
  307. package/data/packages/platform-reporting/api/TypeAlias.ReportingFilterOperator.md +13 -0
  308. package/data/packages/platform-reporting/api/TypeAlias.ReportingQueryResultRow.md +15 -0
  309. package/data/packages/platform-reporting/api/index.md +90 -0
  310. package/data/packages/platform-reporting/index.md +229 -0
  311. package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +118 -0
  312. package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +180 -0
  313. package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +132 -0
  314. package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +231 -0
  315. package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +45 -0
  316. package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +53 -0
  317. package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +90 -0
  318. package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +43 -0
  319. package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +141 -0
  320. package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +43 -0
  321. package/data/packages/platform-telemetry/api/index.md +81 -0
  322. package/data/packages/platform-telemetry/index.md +234 -0
  323. package/package.json +39 -0
  324. package/src/DocsLoader.d.ts +14 -0
  325. package/src/DocsLoader.js +103 -0
  326. package/src/knowledge/configPattern.d.ts +5 -0
  327. package/src/knowledge/configPattern.js +211 -0
  328. package/src/knowledge/dtoPattern.d.ts +5 -0
  329. package/src/knowledge/dtoPattern.js +286 -0
  330. package/src/knowledge/errorHandlingPattern.d.ts +5 -0
  331. package/src/knowledge/errorHandlingPattern.js +219 -0
  332. package/src/knowledge/guardPattern.d.ts +5 -0
  333. package/src/knowledge/guardPattern.js +256 -0
  334. package/src/knowledge/mappingPattern.d.ts +6 -0
  335. package/src/knowledge/mappingPattern.js +322 -0
  336. package/src/knowledge/modulePattern.d.ts +6 -0
  337. package/src/knowledge/modulePattern.js +283 -0
  338. package/src/knowledge/queryPattern.d.ts +6 -0
  339. package/src/knowledge/queryPattern.js +215 -0
  340. package/src/knowledge/repositoryPattern.d.ts +6 -0
  341. package/src/knowledge/repositoryPattern.js +367 -0
  342. package/src/knowledge/testingPattern.d.ts +5 -0
  343. package/src/knowledge/testingPattern.js +356 -0
  344. package/src/main.d.ts +2 -0
  345. package/src/main.js +226 -0
  346. package/src/models/IPackageDoc.d.ts +19 -0
  347. package/src/models/IPackageDoc.js +3 -0
@@ -0,0 +1,233 @@
1
+ ---
2
+ title: 'Interface: IHostContentParams'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Interface: IHostContentParams
8
+
9
+ Defined in: [services/HostService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L18)
10
+
11
+ Parameters for generating host content.
12
+
13
+ ## Properties
14
+
15
+ ### actions?
16
+
17
+ ```ts
18
+ optional actions?: {
19
+ description: string;
20
+ link: string;
21
+ }[];
22
+ ```
23
+
24
+ Defined in: [services/HostService.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L38)
25
+
26
+ Optional array of action buttons (CTAs).
27
+
28
+ #### description
29
+
30
+ ```ts
31
+ description: string;
32
+ ```
33
+
34
+ The description of the action (used as button text).
35
+
36
+ #### link
37
+
38
+ ```ts
39
+ link: string;
40
+ ```
41
+
42
+ The link URL for the action.
43
+
44
+ ---
45
+
46
+ ### data?
47
+
48
+ ```ts
49
+ optional data?: Record<string, unknown>;
50
+ ```
51
+
52
+ Defined in: [services/HostService.ts:131](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L131)
53
+
54
+ Optional additional data to be injected into the template.
55
+
56
+ ---
57
+
58
+ ### description
59
+
60
+ ```ts
61
+ description: string;
62
+ ```
63
+
64
+ Defined in: [services/HostService.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L28)
65
+
66
+ The subtitle/description of the page.
67
+
68
+ ---
69
+
70
+ ### features?
71
+
72
+ ```ts
73
+ optional features?: {
74
+ description: string;
75
+ icon?: string;
76
+ link: string;
77
+ title: string;
78
+ }[];
79
+ ```
80
+
81
+ Defined in: [services/HostService.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L54)
82
+
83
+ Optional array of feature cards.
84
+
85
+ #### description
86
+
87
+ ```ts
88
+ description: string;
89
+ ```
90
+
91
+ The description of the feature (used as link text).
92
+
93
+ #### icon?
94
+
95
+ ```ts
96
+ optional icon?: string;
97
+ ```
98
+
99
+ Optional icon (emoji or URL).
100
+
101
+ #### link
102
+
103
+ ```ts
104
+ link: string;
105
+ ```
106
+
107
+ The link URL for the feature.
108
+
109
+ #### title
110
+
111
+ ```ts
112
+ title: string;
113
+ ```
114
+
115
+ The title of the feature.
116
+
117
+ ---
118
+
119
+ ### footer?
120
+
121
+ ```ts
122
+ optional footer?: {
123
+ copyright: string;
124
+ links?: {
125
+ label: string;
126
+ url: string;
127
+ }[];
128
+ stage?: string;
129
+ version?: string;
130
+ };
131
+ ```
132
+
133
+ Defined in: [services/HostService.ts:94](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L94)
134
+
135
+ Optional footer configuration.
136
+
137
+ #### copyright
138
+
139
+ ```ts
140
+ copyright: string;
141
+ ```
142
+
143
+ Copyright text (e.g., "© 2025 Company Name. All rights reserved.").
144
+
145
+ #### links?
146
+
147
+ ```ts
148
+ optional links?: {
149
+ label: string;
150
+ url: string;
151
+ }[];
152
+ ```
153
+
154
+ Optional array of footer links.
155
+
156
+ #### stage?
157
+
158
+ ```ts
159
+ optional stage?: string;
160
+ ```
161
+
162
+ Optional stage label (e.g., "Beta", "Alpha").
163
+
164
+ #### version?
165
+
166
+ ```ts
167
+ optional version?: string;
168
+ ```
169
+
170
+ Optional version string.
171
+
172
+ ---
173
+
174
+ ### health?
175
+
176
+ ```ts
177
+ optional health?: IHealthCheckResult[];
178
+ ```
179
+
180
+ Defined in: [services/HostService.ts:89](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L89)
181
+
182
+ Optional health check result to display.
183
+
184
+ ---
185
+
186
+ ### logo
187
+
188
+ ```ts
189
+ logo: string;
190
+ ```
191
+
192
+ Defined in: [services/HostService.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L33)
193
+
194
+ The logo URL (can be a regular URL or data URL).
195
+
196
+ ---
197
+
198
+ ### style?
199
+
200
+ ```ts
201
+ optional style?: {
202
+ primary: string;
203
+ secondary: string;
204
+ };
205
+ ```
206
+
207
+ Defined in: [services/HostService.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L81)
208
+
209
+ Optional style configuration.
210
+
211
+ #### primary
212
+
213
+ ```ts
214
+ primary: string;
215
+ ```
216
+
217
+ #### secondary
218
+
219
+ ```ts
220
+ secondary: string;
221
+ ```
222
+
223
+ ---
224
+
225
+ ### title
226
+
227
+ ```ts
228
+ title: string;
229
+ ```
230
+
231
+ Defined in: [services/HostService.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L23)
232
+
233
+ The title of the page.
@@ -0,0 +1,58 @@
1
+ ---
2
+ title: 'Interface: IIdGenerator'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Interface: IIdGenerator
8
+
9
+ Defined in: [identifiers/generators/interfaces/IIdGenerator.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/interfaces/IIdGenerator.ts#L4)
10
+
11
+ Interface for ID generators
12
+
13
+ ## Methods
14
+
15
+ ### generate()
16
+
17
+ ```ts
18
+ generate(prefix?, postfix?): string;
19
+ ```
20
+
21
+ Defined in: [identifiers/generators/interfaces/IIdGenerator.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/interfaces/IIdGenerator.ts#L15)
22
+
23
+ Generates a new ID
24
+
25
+ #### Parameters
26
+
27
+ | Parameter | Type | Description |
28
+ | ---------- | -------- | ------------------------------------ |
29
+ | `prefix?` | `string` | Optional prefix to prepend to the ID |
30
+ | `postfix?` | `string` | Optional postfix to append to the ID |
31
+
32
+ #### Returns
33
+
34
+ `string`
35
+
36
+ ---
37
+
38
+ ### isValid()
39
+
40
+ ```ts
41
+ isValid(id): boolean;
42
+ ```
43
+
44
+ Defined in: [identifiers/generators/interfaces/IIdGenerator.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/interfaces/IIdGenerator.ts#L24)
45
+
46
+ Validates if the given ID conforms to the expected format
47
+
48
+ #### Parameters
49
+
50
+ | Parameter | Type | Description |
51
+ | --------- | -------- | ------------------ |
52
+ | `id` | `string` | The ID to validate |
53
+
54
+ #### Returns
55
+
56
+ `boolean`
57
+
58
+ True if the ID is valid, otherwise false
@@ -0,0 +1,31 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceArtifact'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Interface: IIntelligenceArtifact
8
+
9
+ Defined in: [intelligence/contracts/IIntelligenceArtifact.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceArtifact.ts#L10)
10
+
11
+ Represents a structured artifact returned by a capability.
12
+
13
+ ## Properties
14
+
15
+ ### data
16
+
17
+ ```ts
18
+ readonly data: Record<string, unknown>;
19
+ ```
20
+
21
+ Defined in: [intelligence/contracts/IIntelligenceArtifact.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceArtifact.ts#L14)
22
+
23
+ ---
24
+
25
+ ### type
26
+
27
+ ```ts
28
+ readonly type: string;
29
+ ```
30
+
31
+ Defined in: [intelligence/contracts/IIntelligenceArtifact.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceArtifact.ts#L13)
@@ -0,0 +1,62 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceCapability'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Interface: IIntelligenceCapability
8
+
9
+ Defined in: [intelligence/contracts/IIntelligenceCapability.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapability.ts#L16)
10
+
11
+ Abstraction implemented by all capability providers.
12
+
13
+ ## Properties
14
+
15
+ ### metadata
16
+
17
+ ```ts
18
+ readonly metadata: IIntelligenceCapabilityMetadata;
19
+ ```
20
+
21
+ Defined in: [intelligence/contracts/IIntelligenceCapability.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapability.ts#L19)
22
+
23
+ ## Methods
24
+
25
+ ### canHandle()
26
+
27
+ ```ts
28
+ canHandle(intent, context): boolean;
29
+ ```
30
+
31
+ Defined in: [intelligence/contracts/IIntelligenceCapability.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapability.ts#L25)
32
+
33
+ #### Parameters
34
+
35
+ | Parameter | Type |
36
+ | --------- | -------------------------------------------------------- |
37
+ | `intent` | [`IIntelligenceIntent`](Interface.IIntelligenceIntent) |
38
+ | `context` | [`IIntelligenceContext`](Interface.IIntelligenceContext) |
39
+
40
+ #### Returns
41
+
42
+ `boolean`
43
+
44
+ ---
45
+
46
+ ### execute()
47
+
48
+ ```ts
49
+ execute(payload): Promise<IIntelligenceCapabilityResult>;
50
+ ```
51
+
52
+ Defined in: [intelligence/contracts/IIntelligenceCapability.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapability.ts#L26)
53
+
54
+ #### Parameters
55
+
56
+ | Parameter | Type |
57
+ | --------- | ---------------------------------------------------------------------------- |
58
+ | `payload` | [`IIntelligenceCapabilityPayload`](Interface.IIntelligenceCapabilityPayload) |
59
+
60
+ #### Returns
61
+
62
+ `Promise`\<[`IIntelligenceCapabilityResult`](Interface.IIntelligenceCapabilityResult)\>
@@ -0,0 +1,61 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceCapabilityMetadata'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Interface: IIntelligenceCapabilityMetadata
8
+
9
+ Defined in: [intelligence/contracts/IIntelligenceCapabilityMetadata.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityMetadata.ts#L10)
10
+
11
+ Metadata describing a capability for orchestration and analytics purposes.
12
+
13
+ ## Properties
14
+
15
+ ### description
16
+
17
+ ```ts
18
+ readonly description: string;
19
+ ```
20
+
21
+ Defined in: [intelligence/contracts/IIntelligenceCapabilityMetadata.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityMetadata.ts#L15)
22
+
23
+ ---
24
+
25
+ ### id
26
+
27
+ ```ts
28
+ readonly id: string;
29
+ ```
30
+
31
+ Defined in: [intelligence/contracts/IIntelligenceCapabilityMetadata.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityMetadata.ts#L13)
32
+
33
+ ---
34
+
35
+ ### intentName
36
+
37
+ ```ts
38
+ readonly intentName: string;
39
+ ```
40
+
41
+ Defined in: [intelligence/contracts/IIntelligenceCapabilityMetadata.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityMetadata.ts#L17)
42
+
43
+ ---
44
+
45
+ ### name
46
+
47
+ ```ts
48
+ readonly name: string;
49
+ ```
50
+
51
+ Defined in: [intelligence/contracts/IIntelligenceCapabilityMetadata.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityMetadata.ts#L14)
52
+
53
+ ---
54
+
55
+ ### priority
56
+
57
+ ```ts
58
+ readonly priority: number;
59
+ ```
60
+
61
+ Defined in: [intelligence/contracts/IIntelligenceCapabilityMetadata.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityMetadata.ts#L16)
@@ -0,0 +1,41 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceCapabilityPayload'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Interface: IIntelligenceCapabilityPayload
8
+
9
+ Defined in: [intelligence/contracts/IIntelligenceCapabilityPayload.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityPayload.ts#L13)
10
+
11
+ Payload forwarded to capabilities for execution.
12
+
13
+ ## Properties
14
+
15
+ ### context
16
+
17
+ ```ts
18
+ readonly context: IIntelligenceContext;
19
+ ```
20
+
21
+ Defined in: [intelligence/contracts/IIntelligenceCapabilityPayload.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityPayload.ts#L17)
22
+
23
+ ---
24
+
25
+ ### intent
26
+
27
+ ```ts
28
+ readonly intent: IIntelligenceIntent;
29
+ ```
30
+
31
+ Defined in: [intelligence/contracts/IIntelligenceCapabilityPayload.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityPayload.ts#L16)
32
+
33
+ ---
34
+
35
+ ### userMessage
36
+
37
+ ```ts
38
+ readonly userMessage: string;
39
+ ```
40
+
41
+ Defined in: [intelligence/contracts/IIntelligenceCapabilityPayload.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityPayload.ts#L18)
@@ -0,0 +1,69 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceCapabilityRegistry'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Interface: IIntelligenceCapabilityRegistry
8
+
9
+ Defined in: [intelligence/IIntelligenceCapabilityRegistry.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IIntelligenceCapabilityRegistry.ts#L14)
10
+
11
+ Registry abstraction responsible for resolving capabilities.
12
+
13
+ ## Methods
14
+
15
+ ### list()
16
+
17
+ ```ts
18
+ list(): readonly IIntelligenceCapability[];
19
+ ```
20
+
21
+ Defined in: [intelligence/IIntelligenceCapabilityRegistry.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IIntelligenceCapabilityRegistry.ts#L22)
22
+
23
+ #### Returns
24
+
25
+ readonly [`IIntelligenceCapability`](Interface.IIntelligenceCapability)[]
26
+
27
+ ---
28
+
29
+ ### register()
30
+
31
+ ```ts
32
+ register(capability): void;
33
+ ```
34
+
35
+ Defined in: [intelligence/IIntelligenceCapabilityRegistry.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IIntelligenceCapabilityRegistry.ts#L18)
36
+
37
+ #### Parameters
38
+
39
+ | Parameter | Type |
40
+ | ------------ | -------------------------------------------------------------- |
41
+ | `capability` | [`IIntelligenceCapability`](Interface.IIntelligenceCapability) |
42
+
43
+ #### Returns
44
+
45
+ `void`
46
+
47
+ ---
48
+
49
+ ### resolve()
50
+
51
+ ```ts
52
+ resolve(intent, context):
53
+ | IIntelligenceCapability
54
+ | null;
55
+ ```
56
+
57
+ Defined in: [intelligence/IIntelligenceCapabilityRegistry.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IIntelligenceCapabilityRegistry.ts#L20)
58
+
59
+ #### Parameters
60
+
61
+ | Parameter | Type |
62
+ | --------- | -------------------------------------------------------- |
63
+ | `intent` | [`IIntelligenceIntent`](Interface.IIntelligenceIntent) |
64
+ | `context` | [`IIntelligenceContext`](Interface.IIntelligenceContext) |
65
+
66
+ #### Returns
67
+
68
+ \| [`IIntelligenceCapability`](Interface.IIntelligenceCapability)
69
+ \| `null`
@@ -0,0 +1,41 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceCapabilityResult'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Interface: IIntelligenceCapabilityResult
8
+
9
+ Defined in: [intelligence/contracts/IIntelligenceCapabilityResult.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityResult.ts#L14)
10
+
11
+ Represents the outcome produced by a capability execution.
12
+
13
+ ## Properties
14
+
15
+ ### artifacts
16
+
17
+ ```ts
18
+ readonly artifacts: readonly IIntelligenceArtifact[];
19
+ ```
20
+
21
+ Defined in: [intelligence/contracts/IIntelligenceCapabilityResult.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityResult.ts#L18)
22
+
23
+ ---
24
+
25
+ ### followUps
26
+
27
+ ```ts
28
+ readonly followUps: readonly IIntelligenceFollowUpQuestion[];
29
+ ```
30
+
31
+ Defined in: [intelligence/contracts/IIntelligenceCapabilityResult.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityResult.ts#L19)
32
+
33
+ ---
34
+
35
+ ### messages
36
+
37
+ ```ts
38
+ readonly messages: readonly IIntelligenceResponseMessage[];
39
+ ```
40
+
41
+ Defined in: [intelligence/contracts/IIntelligenceCapabilityResult.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityResult.ts#L17)
@@ -0,0 +1,41 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceCompletionUsage'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Interface: IIntelligenceCompletionUsage
8
+
9
+ Defined in: [intelligence/contracts/IIntelligenceCompletionUsage.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCompletionUsage.ts#L10)
10
+
11
+ Captures usage telemetry returned by the intelligence provider.
12
+
13
+ ## Properties
14
+
15
+ ### completionTokens
16
+
17
+ ```ts
18
+ readonly completionTokens: number | null;
19
+ ```
20
+
21
+ Defined in: [intelligence/contracts/IIntelligenceCompletionUsage.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCompletionUsage.ts#L14)
22
+
23
+ ---
24
+
25
+ ### promptTokens
26
+
27
+ ```ts
28
+ readonly promptTokens: number | null;
29
+ ```
30
+
31
+ Defined in: [intelligence/contracts/IIntelligenceCompletionUsage.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCompletionUsage.ts#L13)
32
+
33
+ ---
34
+
35
+ ### totalTokens
36
+
37
+ ```ts
38
+ readonly totalTokens: number | null;
39
+ ```
40
+
41
+ Defined in: [intelligence/contracts/IIntelligenceCompletionUsage.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCompletionUsage.ts#L15)
@@ -0,0 +1,63 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceContext'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Interface: IIntelligenceContext
8
+
9
+ Defined in: [intelligence/contracts/IIntelligenceContext.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceContext.ts#L12)
10
+
11
+ Describes the context aggregated before routing a request to a capability.
12
+
13
+ ## Properties
14
+
15
+ ### conversationId
16
+
17
+ ```ts
18
+ readonly conversationId: string | null;
19
+ ```
20
+
21
+ Defined in: [intelligence/contracts/IIntelligenceContext.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceContext.ts#L16)
22
+
23
+ ---
24
+
25
+ ### conversationPreview
26
+
27
+ ```ts
28
+ readonly conversationPreview:
29
+ | IIntelligenceConversationSnapshot
30
+ | null;
31
+ ```
32
+
33
+ Defined in: [intelligence/contracts/IIntelligenceContext.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceContext.ts#L17)
34
+
35
+ ---
36
+
37
+ ### nutritionSnapshot?
38
+
39
+ ```ts
40
+ readonly optional nutritionSnapshot?: Record<string, unknown> | null;
41
+ ```
42
+
43
+ Defined in: [intelligence/contracts/IIntelligenceContext.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceContext.ts#L19)
44
+
45
+ ---
46
+
47
+ ### userId
48
+
49
+ ```ts
50
+ readonly userId: string;
51
+ ```
52
+
53
+ Defined in: [intelligence/contracts/IIntelligenceContext.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceContext.ts#L15)
54
+
55
+ ---
56
+
57
+ ### workoutSummary?
58
+
59
+ ```ts
60
+ readonly optional workoutSummary?: Record<string, unknown> | null;
61
+ ```
62
+
63
+ Defined in: [intelligence/contracts/IIntelligenceContext.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceContext.ts#L18)