@breadstone/archipel-mcp 0.0.54 → 0.0.55

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 (208) hide show
  1. package/data/guides/ai-image-generation.md +96 -0
  2. package/data/guides/ai-realtime-voice.md +69 -464
  3. package/data/guides/ai-text-generation.md +95 -626
  4. package/data/guides/index.md +2 -1
  5. package/data/guides/intelligence-prompts-warm-up.md +63 -283
  6. package/data/packages/platform-intelligence/api/Class.AnthropicIntelligenceProviderAdapter.md +78 -0
  7. package/data/packages/platform-intelligence/api/Class.GatewayIntelligenceProviderAdapter.md +78 -0
  8. package/data/packages/platform-intelligence/api/Class.GoogleIntelligenceProviderAdapter.md +78 -0
  9. package/data/packages/platform-intelligence/api/Class.GrokIntelligenceProviderAdapter.md +78 -0
  10. package/data/packages/platform-intelligence/api/Class.IntelligenceAgent.md +95 -0
  11. package/data/packages/platform-intelligence/api/Class.IntelligenceAgentFactory.md +11 -23
  12. package/data/packages/platform-intelligence/api/Class.IntelligenceEmbeddingGenerator.md +25 -21
  13. package/data/packages/platform-intelligence/api/Class.IntelligenceHealthIndicator.md +11 -7
  14. package/data/packages/platform-intelligence/api/Class.IntelligenceLanguageGenerator.md +159 -0
  15. package/data/packages/platform-intelligence/api/Class.IntelligenceMediaGenerator.md +60 -38
  16. package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +2 -2
  17. package/data/packages/platform-intelligence/api/Class.IntelligencePromptExecutor.md +6 -6
  18. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderAssetUploader.md +21 -15
  19. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderDiagnostics.md +55 -0
  20. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderError.md +14 -4
  21. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderRegistry.md +68 -0
  22. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeError.md +9 -9
  23. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionFactory.md +12 -12
  24. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionPort.md +18 -18
  25. package/data/packages/platform-intelligence/api/Class.IntelligenceReranker.md +58 -0
  26. package/data/packages/platform-intelligence/api/Class.IntelligenceToolBase.md +14 -16
  27. package/data/packages/platform-intelligence/api/Class.IntelligenceToolRegistry.md +10 -14
  28. package/data/packages/platform-intelligence/api/Class.MiMoIntelligenceProviderAdapter.md +78 -0
  29. package/data/packages/platform-intelligence/api/Class.OpenAIIntelligenceProviderAdapter.md +102 -0
  30. package/data/packages/platform-intelligence/api/Function.createAnthropicAdvisor20260301Tool.md +1 -1
  31. package/data/packages/platform-intelligence/api/Function.createAnthropicBash20241022Tool.md +1 -1
  32. package/data/packages/platform-intelligence/api/Function.createAnthropicBash20250124Tool.md +1 -1
  33. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250522Tool.md +1 -1
  34. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250825Tool.md +1 -1
  35. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20260120Tool.md +1 -1
  36. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20241022Tool.md +1 -1
  37. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20250124Tool.md +1 -1
  38. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20251124Tool.md +1 -1
  39. package/data/packages/platform-intelligence/api/Function.createAnthropicMemory20250818Tool.md +1 -1
  40. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20241022Tool.md +1 -1
  41. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250124Tool.md +1 -1
  42. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250429Tool.md +1 -1
  43. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250728Tool.md +1 -1
  44. package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchBM2520251119Tool.md +1 -1
  45. package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchRegex20251119Tool.md +1 -1
  46. package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20250910Tool.md +1 -1
  47. package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20260209Tool.md +1 -1
  48. package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20250305Tool.md +1 -1
  49. package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20260209Tool.md +1 -1
  50. package/data/packages/platform-intelligence/api/Function.createGoogleCodeExecutionTool.md +1 -1
  51. package/data/packages/platform-intelligence/api/Function.createGoogleEnterpriseWebSearchTool.md +1 -1
  52. package/data/packages/platform-intelligence/api/Function.createGoogleFileSearchTool.md +1 -1
  53. package/data/packages/platform-intelligence/api/Function.createGoogleGoogleMapsTool.md +1 -1
  54. package/data/packages/platform-intelligence/api/Function.createGoogleGoogleSearchTool.md +1 -1
  55. package/data/packages/platform-intelligence/api/Function.createGoogleUrlContextTool.md +1 -1
  56. package/data/packages/platform-intelligence/api/Function.createGoogleVertexRagStoreTool.md +1 -1
  57. package/data/packages/platform-intelligence/api/Function.createGrokCodeExecutionTool.md +1 -1
  58. package/data/packages/platform-intelligence/api/Function.createGrokFileSearchTool.md +1 -1
  59. package/data/packages/platform-intelligence/api/Function.createGrokMcpServerTool.md +1 -1
  60. package/data/packages/platform-intelligence/api/Function.createGrokViewImageTool.md +1 -1
  61. package/data/packages/platform-intelligence/api/Function.createGrokViewXVideoTool.md +1 -1
  62. package/data/packages/platform-intelligence/api/Function.createGrokWebSearchTool.md +1 -1
  63. package/data/packages/platform-intelligence/api/Function.createGrokXSearchTool.md +1 -1
  64. package/data/packages/platform-intelligence/api/Function.createIntelligenceJsonSchema.md +31 -0
  65. package/data/packages/platform-intelligence/api/Function.createIntelligenceTool.md +2 -2
  66. package/data/packages/platform-intelligence/api/Function.createMimoCustomTool.md +5 -5
  67. package/data/packages/platform-intelligence/api/Function.createOpenAIApplyPatchTool.md +1 -1
  68. package/data/packages/platform-intelligence/api/Function.createOpenAICodeInterpreterTool.md +1 -1
  69. package/data/packages/platform-intelligence/api/Function.createOpenAICustomTool.md +1 -1
  70. package/data/packages/platform-intelligence/api/Function.createOpenAIFileSearchTool.md +1 -1
  71. package/data/packages/platform-intelligence/api/Function.createOpenAIImageGenerationTool.md +1 -1
  72. package/data/packages/platform-intelligence/api/Function.createOpenAILocalShellTool.md +1 -1
  73. package/data/packages/platform-intelligence/api/Function.createOpenAIMcpTool.md +1 -1
  74. package/data/packages/platform-intelligence/api/Function.createOpenAIShellTool.md +1 -1
  75. package/data/packages/platform-intelligence/api/Function.createOpenAIToolSearchTool.md +1 -1
  76. package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchPreviewTool.md +1 -1
  77. package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchTool.md +1 -1
  78. package/data/packages/platform-intelligence/api/Function.defineIntelligenceTool.md +31 -0
  79. package/data/packages/platform-intelligence/api/Interface.IIntelligenceAgentConfiguration.md +70 -0
  80. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchOptions.md +124 -0
  81. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchResult.md +70 -0
  82. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingOptions.md +114 -0
  83. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingResult.md +70 -0
  84. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadOptions.md +102 -0
  85. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadResult.md +60 -0
  86. package/data/packages/platform-intelligence/api/Interface.IIntelligenceGeneratedFile.md +40 -0
  87. package/data/packages/platform-intelligence/api/Interface.IIntelligenceGenerationStepStartEvent.md +50 -0
  88. package/data/packages/platform-intelligence/api/Interface.IIntelligenceImageGenerationOptions.md +170 -0
  89. package/data/packages/platform-intelligence/api/Interface.IIntelligenceImageGenerationResult.md +60 -0
  90. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageCompletion.md +141 -0
  91. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageGenerationOptions.md +234 -0
  92. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageStream.md +50 -0
  93. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelReference.md +34 -0
  94. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelRequestOptions.md +52 -0
  95. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelStatus.md +30 -0
  96. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +33 -27
  97. package/data/packages/platform-intelligence/api/Interface.IIntelligenceObjectStream.md +56 -0
  98. package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +50 -0
  99. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptDefinition.md +14 -14
  100. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptEffectivePolicy.md +1 -1
  101. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionPolicy.md +1 -1
  102. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionResult.md +15 -27
  103. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderAdapter.md +73 -0
  104. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +10 -10
  105. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderLoadRequest.md +40 -0
  106. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderProbeResult.md +70 -0
  107. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeModuleOptions.md +9 -21
  108. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionOptions.md +11 -11
  109. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRequestOptions.md +98 -0
  110. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingOptions.md +140 -0
  111. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingResult.md +50 -0
  112. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadOptions.md +94 -0
  113. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadResult.md +80 -0
  114. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationOptions.md +164 -0
  115. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationResult.md +50 -0
  116. package/data/packages/platform-intelligence/api/Interface.IIntelligenceStreamingTranscriptionOptions.md +139 -0
  117. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTool.md +7 -10
  118. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolCall.md +40 -0
  119. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolDefinition.md +91 -0
  120. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolExecutionEndEvent.md +50 -0
  121. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolExecutionStartEvent.md +30 -0
  122. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolRegistry.md +4 -4
  123. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionOptions.md +114 -0
  124. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionResult.md +84 -0
  125. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionStream.md +97 -0
  126. package/data/packages/platform-intelligence/api/Interface.IIntelligenceUsage.md +40 -0
  127. package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationOptions.md +229 -0
  128. package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationResult.md +50 -0
  129. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligenceModelMessage.md +43 -0
  130. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligencePromptModelRequirement.md +2 -2
  131. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligenceSchema.md +70 -0
  132. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceCapability.md +14 -0
  133. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceDefaultModels.md +14 -0
  134. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceJsonValue.md +22 -0
  135. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptDefinitionConfiguration.md +2 -2
  136. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptGenerationOptions.md +1 -1
  137. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +1 -1
  138. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderOptions.md +14 -0
  139. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderProbeStatus.md +14 -0
  140. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderToolOptions.md +17 -0
  141. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMeteringEvent.md +1 -1
  142. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRequestTimeouts.md +14 -0
  143. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolChoice.md +21 -0
  144. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolOutput.md +22 -0
  145. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolSet.md +14 -0
  146. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTranscriptionStreamPart.md +46 -0
  147. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_API_KEY.md +14 -0
  148. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_BASE_URL.md +14 -0
  149. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_CONFIG_ENTRIES.md +14 -0
  150. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_API_KEY.md +1 -1
  151. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_BASE_URL.md +1 -1
  152. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -1
  153. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MODEL.md +1 -1
  154. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_PROVIDER.md +2 -2
  155. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -1
  156. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TOP_P.md +1 -1
  157. package/data/packages/platform-intelligence/api/Variable.IntelligenceCapabilityNames.md +40 -0
  158. package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +2 -0
  159. package/data/packages/platform-intelligence/api/Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES.md +1 -1
  160. package/data/packages/platform-intelligence/api/index.md +78 -30
  161. package/package.json +1 -1
  162. package/data/packages/index.md +0 -8
  163. package/data/packages/platform-analytics/index.md +0 -209
  164. package/data/packages/platform-authentication/index.md +0 -725
  165. package/data/packages/platform-blob-storage/index.md +0 -416
  166. package/data/packages/platform-bootstrap/index.md +0 -162
  167. package/data/packages/platform-caching/index.md +0 -167
  168. package/data/packages/platform-configuration/index.md +0 -226
  169. package/data/packages/platform-core/index.md +0 -504
  170. package/data/packages/platform-cryptography/index.md +0 -142
  171. package/data/packages/platform-database/index.md +0 -337
  172. package/data/packages/platform-documents/index.md +0 -255
  173. package/data/packages/platform-esigning/index.md +0 -710
  174. package/data/packages/platform-feature-flags/index.md +0 -103
  175. package/data/packages/platform-health/index.md +0 -141
  176. package/data/packages/platform-intelligence/api/Class.IntelligenceStructuredGenerator.md +0 -70
  177. package/data/packages/platform-intelligence/api/Class.IntelligenceTelemetryRegistry.md +0 -44
  178. package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +0 -138
  179. package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +0 -39
  180. package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +0 -26
  181. package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +0 -26
  182. package/data/packages/platform-intelligence/api/Function.loadGoogleRealtimeModel.md +0 -25
  183. package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +0 -26
  184. package/data/packages/platform-intelligence/api/Function.loadGrokRealtimeModel.md +0 -25
  185. package/data/packages/platform-intelligence/api/Function.loadMimoLanguageModel.md +0 -26
  186. package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +0 -26
  187. package/data/packages/platform-intelligence/api/Function.loadOpenAIRealtimeModel.md +0 -25
  188. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +0 -46
  189. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +0 -180
  190. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +0 -144
  191. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +0 -78
  192. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextStreamingOptions.md +0 -170
  193. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +0 -24
  194. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoaders.md +0 -14
  195. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoader.md +0 -25
  196. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoaders.md +0 -14
  197. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTextStream.md +0 -14
  198. package/data/packages/platform-intelligence/index.md +0 -627
  199. package/data/packages/platform-logging/index.md +0 -150
  200. package/data/packages/platform-mailing/index.md +0 -470
  201. package/data/packages/platform-mapping/index.md +0 -123
  202. package/data/packages/platform-mcp/index.md +0 -335
  203. package/data/packages/platform-openapi/index.md +0 -207
  204. package/data/packages/platform-payments/index.md +0 -610
  205. package/data/packages/platform-queue/index.md +0 -192
  206. package/data/packages/platform-reporting/index.md +0 -233
  207. package/data/packages/platform-resources/index.md +0 -137
  208. package/data/packages/platform-telemetry/index.md +0 -262
@@ -9,34 +9,60 @@ editUrl: false
9
9
 
10
10
  | Class | Description |
11
11
  | ------ | ------ |
12
+ | [AnthropicIntelligenceProviderAdapter](Class.AnthropicIntelligenceProviderAdapter) | Anthropic adapter for language, files, and skills. |
12
13
  | [DefaultIntelligencePromptPolicyAdapter](Class.DefaultIntelligencePromptPolicyAdapter) | Default prompt policy that supports native settings and automatic model selection. |
13
- | [IntelligenceAgentFactory](Class.IntelligenceAgentFactory) | Creates AI SDK 7 tool-loop agents with platform-registered tools merged in. |
14
+ | [GatewayIntelligenceProviderAdapter](Class.GatewayIntelligenceProviderAdapter) | Vercel AI Gateway adapter spanning all standardized model capabilities. |
15
+ | [GoogleIntelligenceProviderAdapter](Class.GoogleIntelligenceProviderAdapter) | Google adapter for language, embeddings, images, speech, video, realtime, and files. |
16
+ | [GrokIntelligenceProviderAdapter](Class.GrokIntelligenceProviderAdapter) | xAI Grok adapter for language, image, speech, transcription, video, realtime, and files. |
17
+ | [IntelligenceAgent](Class.IntelligenceAgent) | Reusable provider-neutral agent backed by the language capability. |
18
+ | [IntelligenceAgentFactory](Class.IntelligenceAgentFactory) | Creates reusable provider-neutral tool-loop agents. |
14
19
  | [IntelligenceConfigurationError](Class.IntelligenceConfigurationError) | Error thrown when an intelligence provider configuration is invalid or missing. |
15
- | [IntelligenceEmbeddingGenerator](Class.IntelligenceEmbeddingGenerator) | Executes AI SDK embedding operations. |
20
+ | [IntelligenceEmbeddingGenerator](Class.IntelligenceEmbeddingGenerator) | Provider-neutral single and batch embedding facade. |
16
21
  | [IntelligenceHealthIndicator](Class.IntelligenceHealthIndicator) | Health indicator for the intelligence infrastructure. Verifies that the intelligence provider configuration can be resolved. |
17
- | [IntelligenceMediaGenerator](Class.IntelligenceMediaGenerator) | Executes AI SDK media generation and understanding operations. |
22
+ | [IntelligenceLanguageGenerator](Class.IntelligenceLanguageGenerator) | Provider-neutral language generation, structured output, and streaming facade. |
23
+ | [IntelligenceMediaGenerator](Class.IntelligenceMediaGenerator) | Single provider-neutral facade for image, speech, transcription, and video. |
18
24
  | [IntelligenceModule](Class.IntelligenceModule) | Core module exposing the shared intelligence infrastructure. |
19
25
  | [IntelligencePromptExecutor](Class.IntelligencePromptExecutor) | Validates and executes reusable intelligence prompt invocations. |
20
26
  | [IntelligencePromptPolicyPort](Class.IntelligencePromptPolicyPort) | Resolves provider-neutral prompt requirements into effective generation settings. |
21
- | [IntelligenceProviderAssetUploader](Class.IntelligenceProviderAssetUploader) | Uploads provider-managed files and skills for reuse in AI SDK calls. |
27
+ | [IntelligenceProviderAssetUploader](Class.IntelligenceProviderAssetUploader) | Uploads provider-managed files and skills behind provider-neutral contracts. |
28
+ | [IntelligenceProviderDiagnostics](Class.IntelligenceProviderDiagnostics) | Performs bounded, provider-neutral provider availability diagnostics. |
22
29
  | [IntelligenceProviderError](Class.IntelligenceProviderError) | Error thrown when an intelligence provider call fails. |
30
+ | [IntelligenceProviderRegistry](Class.IntelligenceProviderRegistry) | Immutable registry of provider adapters and their supported capabilities. |
23
31
  | [IntelligenceRealtimeError](Class.IntelligenceRealtimeError) | Error raised by a realtime session, transport, or metering adapter. |
24
32
  | [IntelligenceRealtimeMeteringPort](Class.IntelligenceRealtimeMeteringPort) | Application port for idempotently persisting realtime billing and audit events. |
25
33
  | [IntelligenceRealtimeSessionFactory](Class.IntelligenceRealtimeSessionFactory) | Creates and owns server-side, provider-neutral realtime AI sessions. |
26
34
  | [IntelligenceRealtimeSessionPort](Class.IntelligenceRealtimeSessionPort) | Provider-neutral control surface for one realtime model connection. |
27
- | [IntelligenceStructuredGenerator](Class.IntelligenceStructuredGenerator) | Executes AI SDK structured-output generation. |
28
- | [IntelligenceTelemetryRegistry](Class.IntelligenceTelemetryRegistry) | Registers AI SDK telemetry integrations for the current process. |
29
- | [IntelligenceTextGenerator](Class.IntelligenceTextGenerator) | Executes text completions using the configured intelligence provider. |
30
- | [IntelligenceToolBase](Class.IntelligenceToolBase) | Base class for class-based AI SDK tools. |
35
+ | [IntelligenceReranker](Class.IntelligenceReranker) | Provider-neutral semantic reranking facade. |
36
+ | [IntelligenceToolBase](Class.IntelligenceToolBase) | Base class for class-based intelligence tools. |
31
37
  | [IntelligenceToolRegistry](Class.IntelligenceToolRegistry) | Registry for class-based intelligence tools. |
32
38
  | [IntelligenceValidationError](Class.IntelligenceValidationError) | Error thrown when an intelligence input validation fails. |
39
+ | [MiMoIntelligenceProviderAdapter](Class.MiMoIntelligenceProviderAdapter) | Xiaomi MiMo OpenAI-compatible language adapter. |
40
+ | [OpenAIIntelligenceProviderAdapter](Class.OpenAIIntelligenceProviderAdapter) | OpenAI adapter for language, embeddings, images, audio, realtime, files, and skills. |
33
41
 
34
42
  ## Interfaces
35
43
 
36
44
  | Interface | Description |
37
45
  | ------ | ------ |
38
- | [IIntelligenceCompletionUsage](Interface.IIntelligenceCompletionUsage) | Captures usage telemetry returned by the intelligence provider. |
46
+ | [IIntelligenceAgentConfiguration](Interface.IIntelligenceAgentConfiguration) | Reusable provider-neutral tool-loop agent configuration. |
47
+ | [IIntelligenceEmbeddingBatchOptions](Interface.IIntelligenceEmbeddingBatchOptions) | Provider-neutral batch embedding options. |
48
+ | [IIntelligenceEmbeddingBatchResult](Interface.IIntelligenceEmbeddingBatchResult) | Provider-neutral batch embedding result. |
49
+ | [IIntelligenceEmbeddingOptions](Interface.IIntelligenceEmbeddingOptions) | Provider-neutral single-value embedding options. |
50
+ | [IIntelligenceEmbeddingResult](Interface.IIntelligenceEmbeddingResult) | Provider-neutral embedding result. |
51
+ | [IIntelligenceFileUploadOptions](Interface.IIntelligenceFileUploadOptions) | Provider-neutral file upload options. |
52
+ | [IIntelligenceFileUploadResult](Interface.IIntelligenceFileUploadResult) | Normalized provider-managed file upload result. |
53
+ | [IIntelligenceGeneratedFile](Interface.IIntelligenceGeneratedFile) | Binary content generated by an intelligence capability. |
54
+ | [IIntelligenceGenerationStepStartEvent](Interface.IIntelligenceGenerationStepStartEvent) | Language generation step metadata. |
55
+ | [IIntelligenceImageGenerationOptions](Interface.IIntelligenceImageGenerationOptions) | Provider-neutral image generation options. |
56
+ | [IIntelligenceImageGenerationResult](Interface.IIntelligenceImageGenerationResult) | Provider-neutral image generation result. |
57
+ | [IIntelligenceLanguageCompletion](Interface.IIntelligenceLanguageCompletion) | Normalized language generation result. |
58
+ | [IIntelligenceLanguageGenerationOptions](Interface.IIntelligenceLanguageGenerationOptions) | Provider-neutral language generation controls. |
59
+ | [IIntelligenceLanguageStream](Interface.IIntelligenceLanguageStream) | Provider-neutral text stream. |
60
+ | [IIntelligenceModelReference](Interface.IIntelligenceModelReference) | Selects a provider-owned model without exposing a provider SDK model object. |
61
+ | [IIntelligenceModelRequestOptions](Interface.IIntelligenceModelRequestOptions) | Shared provider/model controls for intelligence operations. |
62
+ | [IIntelligenceModelStatus](Interface.IIntelligenceModelStatus) | Safe resolved model status that never includes credentials. |
39
63
  | [IIntelligenceModuleOptions](Interface.IIntelligenceModuleOptions) | Options for configuring the intelligence module. |
64
+ | [IIntelligenceObjectStream](Interface.IIntelligenceObjectStream) | Provider-neutral structured-output stream. |
65
+ | [IIntelligencePrompt](Interface.IIntelligencePrompt) | Provider-neutral language-model prompt. |
40
66
  | [IIntelligencePromptDefinition](Interface.IIntelligencePromptDefinition) | Reusable, immutable definition of an intelligence prompt. |
41
67
  | [IIntelligencePromptEffectivePolicy](Interface.IIntelligencePromptEffectivePolicy) | Effective settings resolved for one prompt execution. |
42
68
  | [IIntelligencePromptExecutionContext](Interface.IIntelligencePromptExecutionContext) | Application context made available to prompt policy adapters. |
@@ -45,7 +71,10 @@ editUrl: false
45
71
  | [IIntelligencePromptInvocation](Interface.IIntelligencePromptInvocation) | Bound prompt definition ready for execution. |
46
72
  | [IIntelligencePromptPolicyRequest](Interface.IIntelligencePromptPolicyRequest) | Policy resolution request for one prompt invocation. |
47
73
  | [IIntelligencePromptRenderContext](Interface.IIntelligencePromptRenderContext) | Input exposed to pure prompt rendering functions. |
74
+ | [IIntelligenceProviderAdapter](Interface.IIntelligenceProviderAdapter) | Provider adapter registered with the intelligence capability registry. |
48
75
  | [IIntelligenceProviderConfiguration](Interface.IIntelligenceProviderConfiguration) | Describes the resolved configuration for the intelligence provider. |
76
+ | [IIntelligenceProviderLoadRequest](Interface.IIntelligenceProviderLoadRequest) | Internal model/API load request passed to a provider adapter. |
77
+ | [IIntelligenceProviderProbeResult](Interface.IIntelligenceProviderProbeResult) | Provider-neutral result of a bounded provider availability probe. |
49
78
  | [IIntelligenceRealtimeAudioFormat](Interface.IIntelligenceRealtimeAudioFormat) | Provider-neutral audio format configuration. |
50
79
  | [IIntelligenceRealtimeCloseEvent](Interface.IIntelligenceRealtimeCloseEvent) | Describes why an upstream realtime connection closed. |
51
80
  | [IIntelligenceRealtimeModuleOptions](Interface.IIntelligenceRealtimeModuleOptions) | Module-level resilience and resource limits for realtime intelligence. |
@@ -55,20 +84,37 @@ editUrl: false
55
84
  | [IIntelligenceRealtimeTranscriptionConfiguration](Interface.IIntelligenceRealtimeTranscriptionConfiguration) | Provider-neutral transcription configuration. |
56
85
  | [IIntelligenceRealtimeTurnDetectionConfiguration](Interface.IIntelligenceRealtimeTurnDetectionConfiguration) | Provider-neutral voice activity detection configuration. |
57
86
  | [IIntelligenceRealtimeUsage](Interface.IIntelligenceRealtimeUsage) | Normalized token usage reported by a realtime provider. |
58
- | [IIntelligenceTextCompletion](Interface.IIntelligenceTextCompletion) | Represents the normalized completion result produced by the intelligence provider. |
59
- | [IIntelligenceTextGenerationOptions](Interface.IIntelligenceTextGenerationOptions) | Options that can be supplied when generating text with the intelligence provider. |
60
- | [IIntelligenceTextGenerator](Interface.IIntelligenceTextGenerator) | Abstraction responsible for executing text completions using the configured provider. |
61
- | [IIntelligenceTextStreamingOptions](Interface.IIntelligenceTextStreamingOptions) | Options that can be supplied when streaming text with the intelligence provider. |
87
+ | [IIntelligenceRequestOptions](Interface.IIntelligenceRequestOptions) | Shared execution controls for bounded intelligence requests. |
88
+ | [IIntelligenceRerankingOptions](Interface.IIntelligenceRerankingOptions) | Provider-neutral reranking options. |
89
+ | [IIntelligenceRerankingResult](Interface.IIntelligenceRerankingResult) | Provider-neutral reranking result. |
90
+ | [IIntelligenceSkillUploadOptions](Interface.IIntelligenceSkillUploadOptions) | Provider-neutral skill bundle upload options. |
91
+ | [IIntelligenceSkillUploadResult](Interface.IIntelligenceSkillUploadResult) | Normalized provider-managed skill upload result. |
92
+ | [IIntelligenceSpeechGenerationOptions](Interface.IIntelligenceSpeechGenerationOptions) | Provider-neutral speech generation options. |
93
+ | [IIntelligenceSpeechGenerationResult](Interface.IIntelligenceSpeechGenerationResult) | Provider-neutral speech generation result. |
94
+ | [IIntelligenceStreamingTranscriptionOptions](Interface.IIntelligenceStreamingTranscriptionOptions) | Provider-neutral live transcription options. |
62
95
  | [IIntelligenceTool](Interface.IIntelligenceTool) | Minimal shape required by the intelligence tool registry. |
96
+ | [IIntelligenceToolCall](Interface.IIntelligenceToolCall) | Tool call selected by a language model. |
97
+ | [IIntelligenceToolDefinition](Interface.IIntelligenceToolDefinition) | Provider-neutral application tool definition. |
98
+ | [IIntelligenceToolExecutionEndEvent](Interface.IIntelligenceToolExecutionEndEvent) | Tool execution completion event. |
99
+ | [IIntelligenceToolExecutionStartEvent](Interface.IIntelligenceToolExecutionStartEvent) | Tool execution start event. |
63
100
  | [IIntelligenceToolRegistry](Interface.IIntelligenceToolRegistry) | Contract for the intelligence tool registry. |
101
+ | [IIntelligenceTranscriptionOptions](Interface.IIntelligenceTranscriptionOptions) | Provider-neutral transcription options. |
102
+ | [IIntelligenceTranscriptionResult](Interface.IIntelligenceTranscriptionResult) | Provider-neutral transcription result. |
103
+ | [IIntelligenceTranscriptionStream](Interface.IIntelligenceTranscriptionStream) | Provider-neutral live transcription result. |
104
+ | [IIntelligenceUsage](Interface.IIntelligenceUsage) | Provider-neutral usage counters. |
105
+ | [IIntelligenceVideoGenerationOptions](Interface.IIntelligenceVideoGenerationOptions) | Provider-neutral video generation options. |
106
+ | [IIntelligenceVideoGenerationResult](Interface.IIntelligenceVideoGenerationResult) | Provider-neutral video generation result. |
64
107
 
65
108
  ## Type Aliases
66
109
 
67
110
  | Type Alias | Description |
68
111
  | ------ | ------ |
112
+ | [IIntelligenceModelMessage](TypeAlias.IIntelligenceModelMessage) | Provider-neutral conversation message. |
69
113
  | [IIntelligencePromptModelRequirement](TypeAlias.IIntelligencePromptModelRequirement) | Model selection requested by a reusable intelligence prompt. |
70
- | [IntelligenceLanguageModelLoader](TypeAlias.IntelligenceLanguageModelLoader) | Represents a factory responsible for creating a configured language model instance. |
71
- | [IntelligenceLanguageModelLoaders](TypeAlias.IntelligenceLanguageModelLoaders) | Maps configured intelligence providers to their tree-shakable model loader. |
114
+ | [IIntelligenceSchema](TypeAlias.IIntelligenceSchema) | Provider-neutral schema accepted by prompts, structured outputs, and tools. |
115
+ | [IntelligenceCapability](TypeAlias.IntelligenceCapability) | Intelligence capability identifier. |
116
+ | [IntelligenceDefaultModels](TypeAlias.IntelligenceDefaultModels) | Capability-specific default provider and model references. |
117
+ | [IntelligenceJsonValue](TypeAlias.IntelligenceJsonValue) | JSON-compatible value used by provider-neutral intelligence contracts. |
72
118
  | [IntelligencePromptCapability](TypeAlias.IntelligencePromptCapability) | Provider-neutral capability required by an intelligence prompt. |
73
119
  | [IntelligencePromptDefinitionConfiguration](TypeAlias.IntelligencePromptDefinitionConfiguration) | Configuration accepted by [intelligencePrompt](Function.intelligencePrompt). |
74
120
  | [IntelligencePromptGenerationOptions](TypeAlias.IntelligencePromptGenerationOptions) | Native generation settings that can be stored on a prompt definition. |
@@ -77,19 +123,27 @@ editUrl: false
77
123
  | [IntelligencePromptQuality](TypeAlias.IntelligencePromptQuality) | Provider-neutral model quality requested by an intelligence prompt. |
78
124
  | [IntelligencePromptReasoning](TypeAlias.IntelligencePromptReasoning) | Provider-neutral reasoning effort requested by an intelligence prompt. |
79
125
  | [IntelligenceProviderName](TypeAlias.IntelligenceProviderName) | Represents the union of supported intelligence provider identifiers. |
126
+ | [IntelligenceProviderOptions](TypeAlias.IntelligenceProviderOptions) | Provider-specific request options kept behind an explicit escape hatch. |
127
+ | [IntelligenceProviderProbeStatus](TypeAlias.IntelligenceProviderProbeStatus) | Normalized provider availability state. |
128
+ | [IntelligenceProviderToolOptions](TypeAlias.IntelligenceProviderToolOptions) | Opaque provider-tool configuration accepted only by provider-specific subpaths. |
80
129
  | [IntelligenceRealtimeClientEvent](TypeAlias.IntelligenceRealtimeClientEvent) | Provider-neutral event sent from an application to a realtime model. |
81
130
  | [IntelligenceRealtimeMetadataValue](TypeAlias.IntelligenceRealtimeMetadataValue) | Serializable metadata copied into realtime metering events. |
82
131
  | [IntelligenceRealtimeMeteringEvent](TypeAlias.IntelligenceRealtimeMeteringEvent) | Durable metering event emitted by an Archipel realtime session. |
83
- | [IntelligenceRealtimeModelLoader](TypeAlias.IntelligenceRealtimeModelLoader) | Creates a configured Vercel AI SDK realtime model behind the Archipel facade. |
84
- | [IntelligenceRealtimeModelLoaders](TypeAlias.IntelligenceRealtimeModelLoaders) | Maps configured intelligence providers to tree-shakable realtime model loaders. |
85
132
  | [IntelligenceRealtimeServerEvent](TypeAlias.IntelligenceRealtimeServerEvent) | Provider-neutral event emitted by a realtime model. |
86
133
  | [IntelligenceRealtimeStatus](TypeAlias.IntelligenceRealtimeStatus) | Describes the lifecycle state of an upstream realtime model connection. |
87
- | [IntelligenceTextStream](TypeAlias.IntelligenceTextStream) | Native AI SDK streaming result returned by the intelligence text generator. |
134
+ | [IntelligenceRequestTimeouts](TypeAlias.IntelligenceRequestTimeouts) | Capability-specific total request timeouts in milliseconds. |
135
+ | [IntelligenceToolChoice](TypeAlias.IntelligenceToolChoice) | Provider-neutral tool-selection policy. |
136
+ | [IntelligenceToolOutput](TypeAlias.IntelligenceToolOutput) | Provider-neutral tool result. |
137
+ | [IntelligenceToolSet](TypeAlias.IntelligenceToolSet) | Provider-neutral named tool collection. |
138
+ | [IntelligenceTranscriptionStreamPart](TypeAlias.IntelligenceTranscriptionStreamPart) | Provider-neutral live transcription event. |
88
139
 
89
140
  ## Variables
90
141
 
91
142
  | Variable | Description |
92
143
  | ------ | ------ |
144
+ | [AI\_GATEWAY\_API\_KEY](Variable.AI_GATEWAY_API_KEY) | Vercel AI Gateway API key. |
145
+ | [AI\_GATEWAY\_BASE\_URL](Variable.AI_GATEWAY_BASE_URL) | Vercel AI Gateway base URL. |
146
+ | [AI\_GATEWAY\_CONFIG\_ENTRIES](Variable.AI_GATEWAY_CONFIG_ENTRIES) | Configuration entries used by the Vercel AI Gateway provider. |
93
147
  | [ANTHROPIC\_API\_KEY](Variable.ANTHROPIC_API_KEY) | Anthropic-specific API key. |
94
148
  | [ANTHROPIC\_BASE\_URL](Variable.ANTHROPIC_BASE_URL) | Anthropic-specific base URL. |
95
149
  | [ANTHROPIC\_CONFIG\_ENTRIES](Variable.ANTHROPIC_CONFIG_ENTRIES) | Configuration entries used by the Anthropic intelligence provider. |
@@ -107,9 +161,10 @@ editUrl: false
107
161
  | [INTELLIGENCE\_BASE\_URL](Variable.INTELLIGENCE_BASE_URL) | Global base URL override for the intelligence provider. |
108
162
  | [INTELLIGENCE\_MAX\_OUTPUT\_TOKENS](Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS) | Maximum number of output tokens for the AI model. |
109
163
  | [INTELLIGENCE\_MODEL](Variable.INTELLIGENCE_MODEL) | AI model identifier to use for text generation. |
110
- | [INTELLIGENCE\_PROVIDER](Variable.INTELLIGENCE_PROVIDER) | Intelligence provider name (e.g. openai, anthropic, google, grok, mimo). |
164
+ | [INTELLIGENCE\_PROVIDER](Variable.INTELLIGENCE_PROVIDER) | Intelligence provider name (e.g. openai, anthropic, google, grok, mimo, gateway). |
111
165
  | [INTELLIGENCE\_TEMPERATURE](Variable.INTELLIGENCE_TEMPERATURE) | Sampling temperature for the AI model. |
112
166
  | [INTELLIGENCE\_TOP\_P](Variable.INTELLIGENCE_TOP_P) | Top-p (nucleus sampling) for the AI model. |
167
+ | [IntelligenceCapabilityNames](Variable.IntelligenceCapabilityNames) | Capability identifiers understood by the intelligence provider registry. |
113
168
  | [IntelligenceProviderNames](Variable.IntelligenceProviderNames) | Enumerates the supported model providers powering the intelligence pipeline. |
114
169
  | [MIMO\_API\_KEY](Variable.MIMO_API_KEY) | MiMo-specific API key. |
115
170
  | [MIMO\_BASE\_URL](Variable.MIMO_BASE_URL) | MiMo-specific base URL. |
@@ -160,8 +215,9 @@ editUrl: false
160
215
  | [createGrokViewXVideoTool](Function.createGrokViewXVideoTool) | Creates a Grok X-video understanding tool registration. |
161
216
  | [createGrokWebSearchTool](Function.createGrokWebSearchTool) | Creates a Grok web-search tool registration. |
162
217
  | [createGrokXSearchTool](Function.createGrokXSearchTool) | Creates a Grok X-search tool registration. |
163
- | [createIntelligenceTool](Function.createIntelligenceTool) | Adapts a native AI SDK tool to the Archipel intelligence tool schema. |
164
- | [createMimoCustomTool](Function.createMimoCustomTool) | Creates a MiMo function tool registration. |
218
+ | [createIntelligenceJsonSchema](Function.createIntelligenceJsonSchema) | Creates a provider-neutral JSON Schema wrapper. |
219
+ | [createIntelligenceTool](Function.createIntelligenceTool) | Creates an Archipel intelligence tool registration. |
220
+ | [createMimoCustomTool](Function.createMimoCustomTool) | Creates a provider-neutral function tool for MiMo. |
165
221
  | [createOpenAIApplyPatchTool](Function.createOpenAIApplyPatchTool) | Creates an OpenAI apply-patch tool registration. |
166
222
  | [createOpenAICodeInterpreterTool](Function.createOpenAICodeInterpreterTool) | Creates an OpenAI code-interpreter tool registration. |
167
223
  | [createOpenAICustomTool](Function.createOpenAICustomTool) | Creates an OpenAI custom provider-defined tool registration. |
@@ -173,13 +229,5 @@ editUrl: false
173
229
  | [createOpenAIToolSearchTool](Function.createOpenAIToolSearchTool) | Creates an OpenAI tool-search tool registration. |
174
230
  | [createOpenAIWebSearchPreviewTool](Function.createOpenAIWebSearchPreviewTool) | Creates an OpenAI web-search-preview tool registration. |
175
231
  | [createOpenAIWebSearchTool](Function.createOpenAIWebSearchTool) | Creates an OpenAI web-search tool registration. |
176
- | [createProviderOptions](Function.createProviderOptions) | Creates the provider options object consumed by the AI SDK model factories. |
232
+ | [defineIntelligenceTool](Function.defineIntelligenceTool) | Defines a provider-neutral intelligence tool while preserving its input and output types. |
177
233
  | [intelligencePrompt](Function.intelligencePrompt) | Creates a reusable intelligence prompt definition. |
178
- | [loadAnthropicLanguageModel](Function.loadAnthropicLanguageModel) | Creates the Anthropic language model from the resolved provider configuration. |
179
- | [loadGoogleLanguageModel](Function.loadGoogleLanguageModel) | Creates the Google Gemini language model from the resolved provider configuration. |
180
- | [loadGoogleRealtimeModel](Function.loadGoogleRealtimeModel) | Creates a Google Gemini Live model exclusively through the Vercel AI SDK provider. |
181
- | [loadGrokLanguageModel](Function.loadGrokLanguageModel) | Creates the Grok language model through the native xAI provider. |
182
- | [loadGrokRealtimeModel](Function.loadGrokRealtimeModel) | Creates an xAI Grok voice model exclusively through the Vercel AI SDK provider. |
183
- | [loadMimoLanguageModel](Function.loadMimoLanguageModel) | Creates the Xiaomi MiMo language model from the resolved provider configuration. |
184
- | [loadOpenAILanguageModel](Function.loadOpenAILanguageModel) | Creates the OpenAI language model from the resolved provider configuration. |
185
- | [loadOpenAIRealtimeModel](Function.loadOpenAIRealtimeModel) | Creates an OpenAI realtime model exclusively through the Vercel AI SDK provider. |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@breadstone/archipel-mcp",
3
- "version": "0.0.54",
3
+ "version": "0.0.55",
4
4
  "description": "MCP server providing Archipel platform knowledge - documentation, query patterns, and coding conventions - to AI development tools.",
5
5
  "type": "commonjs",
6
6
  "main": "./src/main.js",
@@ -1,8 +0,0 @@
1
- ---
2
- title: Packages
3
- description: All Archipel platform packages with their primary capabilities.
4
- ---
5
-
6
- # Packages
7
-
8
- <PackagesOverview />
@@ -1,209 +0,0 @@
1
- ---
2
- title: platform-analytics
3
- description: Provider-agnostic analytics and error tracking with pluggable clients.
4
- order: 14
5
- tags: [analytics, error-tracking, sentry, application-insights, datadog, observability, providers, health]
6
- package: '@breadstone/archipel-platform-analytics'
7
- ---
8
-
9
- # platform-analytics
10
-
11
- Provider-agnostic analytics and error tracking module supporting multiple backends. Ships with Sentry, Azure Application Insights, and Datadog clients out of the box, plus a no-op fallback for environments where analytics is disabled.
12
-
13
- **Package:** `@breadstone/archipel-platform-analytics`
14
-
15
- <InstallTabs />
16
-
17
- ## Quick Start
18
-
19
- ```typescript
20
- import { Module } from '@nestjs/common';
21
- import { AnalyticsModule } from '@breadstone/archipel-platform-analytics';
22
- import { SentryAnalyticsClient, SENTRY_CONFIG_ENTRIES } from '@breadstone/archipel-platform-analytics/sentry';
23
-
24
- @Module({
25
- imports: [
26
- AnalyticsModule.register({
27
- analyticsClient: SentryAnalyticsClient,
28
- configEntries: SENTRY_CONFIG_ENTRIES,
29
- isGlobal: true,
30
- }),
31
- ],
32
- })
33
- export class AppModule {}
34
- ```
35
-
36
- ---
37
-
38
- ## Module Configuration
39
-
40
- ### IAnalyticsModuleOptions
41
-
42
- | Property | Type | Required | Default | Description |
43
- | ----------------- | ------------------------------------- | -------- | ------- | ---------------------------------------- |
44
- | `analyticsClient` | `Type<AnalyticsClientPort>` | Yes | — | Concrete analytics client implementation |
45
- | `configEntries` | `ReadonlyArray<IConfigRegistryEntry>` | No | `[]` | Provider-specific configuration entries |
46
- | `isGlobal` | `boolean` | No | `false` | Register as a global module |
47
-
48
- ---
49
-
50
- ## AnalyticsClientPort API
51
-
52
- The abstract port that all analytics clients implement. Inject it anywhere:
53
-
54
- ```typescript
55
- import { AnalyticsClientPort } from '@breadstone/archipel-platform-analytics';
56
-
57
- @Injectable()
58
- export class PaymentService {
59
- constructor(private readonly _analytics: AnalyticsClientPort) {}
60
-
61
- public async processPayment(): Promise<void> {
62
- try {
63
- // ... payment logic
64
- } catch (error) {
65
- this._analytics.captureException(error as Error, { feature: 'payments' });
66
- }
67
- }
68
- }
69
- ```
70
-
71
- ### Methods
72
-
73
- | Method | Signature | Description |
74
- | ------------------ | ------------------------------------------------------------------------------------- | --------------------------------------- |
75
- | `captureException` | `(error: Error, context?: Record<string, unknown>) => void` | Capture an error with optional context |
76
- | `captureMessage` | `(message: string, level: AnalyticsLevel, context?: Record<string, unknown>) => void` | Capture a message at a severity level |
77
- | `setUser` | `(user: IAnalyticsUser) => void` | Set the current user context |
78
- | `clearUser` | `() => void` | Clear the current user context |
79
- | `addBreadcrumb` | `(breadcrumb: IAnalyticsBreadcrumb) => void` | Add a breadcrumb to the analytics trail |
80
-
81
- ---
82
-
83
- ## Built-in Providers
84
-
85
- ### SentryAnalyticsClient
86
-
87
- Error tracking and performance monitoring via Sentry.
88
-
89
- ```typescript
90
- import { SentryAnalyticsClient, SENTRY_CONFIG_ENTRIES } from '@breadstone/archipel-platform-analytics/sentry';
91
-
92
- AnalyticsModule.register({
93
- analyticsClient: SentryAnalyticsClient,
94
- configEntries: SENTRY_CONFIG_ENTRIES,
95
- });
96
- ```
97
-
98
- **Environment variables:** `SENTRY_DSN`, `SENTRY_ENVIRONMENT`
99
-
100
- ### AppInsightsAnalyticsClient
101
-
102
- Azure Application Insights integration.
103
-
104
- ```typescript
105
- import {
106
- AppInsightsAnalyticsClient,
107
- APPINSIGHTS_CONFIG_ENTRIES,
108
- } from '@breadstone/archipel-platform-analytics/appinsights';
109
-
110
- AnalyticsModule.register({
111
- analyticsClient: AppInsightsAnalyticsClient,
112
- configEntries: APPINSIGHTS_CONFIG_ENTRIES,
113
- });
114
- ```
115
-
116
- **Environment variables:** `APPLICATIONINSIGHTS_CONNECTION_STRING`
117
-
118
- ### DatadogAnalyticsClient
119
-
120
- Datadog APM and error tracking.
121
-
122
- ```typescript
123
- import { DatadogAnalyticsClient, DATADOG_CONFIG_ENTRIES } from '@breadstone/archipel-platform-analytics/datadog';
124
-
125
- AnalyticsModule.register({
126
- analyticsClient: DatadogAnalyticsClient,
127
- configEntries: DATADOG_CONFIG_ENTRIES,
128
- });
129
- ```
130
-
131
- **Environment variables:** `DD_SERVICE`, `DD_ENV`
132
-
133
- ### NoopAnalyticsClient
134
-
135
- Silent no-op client for environments where analytics is disabled:
136
-
137
- ```typescript
138
- import { NoopAnalyticsClient } from '@breadstone/archipel-platform-analytics';
139
-
140
- AnalyticsModule.register({
141
- analyticsClient: NoopAnalyticsClient,
142
- });
143
- ```
144
-
145
- ---
146
-
147
- ## Sub-path Imports
148
-
149
- Each provider is tree-shakeable via sub-path imports:
150
-
151
- | Import Path | Contents |
152
- | ----------------------------------------------------- | ------------------------------------------------------ |
153
- | `@breadstone/archipel-platform-analytics` | Core module, port, models, NoopAnalyticsClient |
154
- | `@breadstone/archipel-platform-analytics/sentry` | SentryAnalyticsClient, SENTRY_CONFIG_ENTRIES |
155
- | `@breadstone/archipel-platform-analytics/appinsights` | AppInsightsAnalyticsClient, APPINSIGHTS_CONFIG_ENTRIES |
156
- | `@breadstone/archipel-platform-analytics/datadog` | DatadogAnalyticsClient, DATADOG_CONFIG_ENTRIES |
157
-
158
- ---
159
-
160
- ## Lifecycle & Shutdown
161
-
162
- All built-in clients implement `OnModuleInit` and `OnModuleDestroy`:
163
-
164
- | Phase | Behavior |
165
- | ----------- | --------------------------------------------------------------------------- |
166
- | **Init** | SDK initialization is deferred to `onModuleInit()` — no constructor I/O |
167
- | **Destroy** | Pending events are flushed and the SDK is closed with a 5-second timeout |
168
-
169
- This ensures no events are lost during application shutdown and prevents hanging processes if the analytics backend is unreachable.
170
-
171
- ---
172
-
173
- ## Health Check
174
-
175
- The `AnalyticsHealthIndicator` verifies that an `AnalyticsClientPort` is injected. If no analytics client is registered, it reports `disabled: true`. Import it from the `/health` subpath:
176
-
177
- ```typescript
178
- import { AnalyticsHealthIndicator } from '@breadstone/archipel-platform-analytics/health';
179
- import { HealthModule } from '@breadstone/archipel-platform-health';
180
-
181
- @Module({
182
- imports: [
183
- AnalyticsModule.register({ /* ... */ }),
184
- HealthModule.withIndicators([AnalyticsHealthIndicator]),
185
- ],
186
- })
187
- export class AppModule {}
188
- ```
189
-
190
- | Key | Check | Dependencies |
191
- | --- | ----- | ------------ |
192
- | `analytics` | `up` if `AnalyticsClientPort` injected, else `disabled` | `@Optional() AnalyticsClientPort` |
193
-
194
- ---
195
-
196
- ## Exports Summary
197
-
198
- | Export | Type | Description |
199
- | ---------------------------- | ------------- | ---------------------------------------------- |
200
- | `AnalyticsModule` | NestJS Module | Main module with `register()` |
201
- | `AnalyticsClientPort` | Port | Abstract analytics contract |
202
- | `NoopAnalyticsClient` | Client | No-op fallback implementation |
203
- | `SentryAnalyticsClient` | Client | Sentry provider (sub-path) |
204
- | `AppInsightsAnalyticsClient` | Client | Azure Application Insights provider (sub-path) |
205
- | `DatadogAnalyticsClient` | Client | Datadog provider (sub-path) |
206
- | `AnalyticsLevel` | Type | Severity level union |
207
- | `IAnalyticsBreadcrumb` | Interface | Breadcrumb entry model |
208
- | `IAnalyticsUser` | Interface | User context model |
209
- | `AnalyticsHealthIndicator` | Health | Analytics readiness check (`/health` subpath) |