@breadstone/archipel-mcp 0.0.52 → 0.0.54

package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeUsage.md

@@ -0,0 +1,103 @@
+---
+title: 'Interface: IIntelligenceRealtimeUsage'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligenceRealtimeUsage
+
+Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L9)
+
+Normalized token usage reported by a realtime provider.
+
+Null values mean the provider did not expose that dimension. Applications
+can therefore distinguish missing data from an actual zero-token count.
+
+## Properties
+
+### cachedInputTokens
+
+```ts
+readonly cachedInputTokens: number | null;
+```
+
+Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L15)
+
+***
+
+### inputAudioTokens
+
+```ts
+readonly inputAudioTokens: number | null;
+```
+
+Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L17)
+
+***
+
+### inputTextTokens
+
+```ts
+readonly inputTextTokens: number | null;
+```
+
+Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L16)
+
+***
+
+### inputTokens
+
+```ts
+readonly inputTokens: number | null;
+```
+
+Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L12)
+
+***
+
+### outputAudioTokens
+
+```ts
+readonly outputAudioTokens: number | null;
+```
+
+Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L19)
+
+***
+
+### outputTextTokens
+
+```ts
+readonly outputTextTokens: number | null;
+```
+
+Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L18)
+
+***
+
+### outputTokens
+
+```ts
+readonly outputTokens: number | null;
+```
+
+Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L13)
+
+***
+
+### rawUsage
+
+```ts
+readonly rawUsage: unknown;
+```
+
+Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L20)
+
+***
+
+### totalTokens
+
+```ts
+readonly totalTokens: number | null;
+```
+
+Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L14)

package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md

@@ -17,7 +17,7 @@ Represents the normalized completion result produced by the intelligence provide
 readonly files: readonly GeneratedFile[];
 ```
 
-Defined in: [contracts/IIntelligenceTextCompletion.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L56)
+Defined in: [contracts/IIntelligenceTextCompletion.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L63)
 
 Files generated by provider-native tools such as image generation or code interpreter.
 
@@ -29,7 +29,7 @@ Files generated by provider-native tools such as image generation or code interp
 readonly optional finalStep?: StepResult<ToolSet, Record<string, unknown>>;
 ```
 
-Defined in: [contracts/IIntelligenceTextCompletion.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L84)
+Defined in: [contracts/IIntelligenceTextCompletion.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L91)
 
 Final AI SDK generation step.
 
@@ -41,19 +41,31 @@ Final AI SDK generation step.
 readonly model: string;
 ```
 
-Defined in: [contracts/IIntelligenceTextCompletion.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L42)
+Defined in: [contracts/IIntelligenceTextCompletion.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L49)
 
 The model identifier used for the completion.
 
 ***
 
+### output?
+
+```ts
+readonly optional output?: unknown;
+```
+
+Defined in: [contracts/IIntelligenceTextCompletion.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L35)
+
+Generated output parsed according to the supplied AI SDK output specification.
+
+***
+
 ### provider
 
 ```ts
 readonly provider: string;
 ```
 
-Defined in: [contracts/IIntelligenceTextCompletion.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L35)
+Defined in: [contracts/IIntelligenceTextCompletion.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L42)
 
 The provider that produced the completion.
 
@@ -65,7 +77,7 @@ The provider that produced the completion.
 readonly optional reasoning?: (ReasoningOutput | ReasoningFileOutput)[];
 ```
 
-Defined in: [contracts/IIntelligenceTextCompletion.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L63)
+Defined in: [contracts/IIntelligenceTextCompletion.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L70)
 
 Reasoning parts reported by AI SDK 7 compatible models.
 
@@ -77,7 +89,7 @@ Reasoning parts reported by AI SDK 7 compatible models.
 readonly optional reasoningText?: string;
 ```
 
-Defined in: [contracts/IIntelligenceTextCompletion.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L70)
+Defined in: [contracts/IIntelligenceTextCompletion.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L77)
 
 Concatenated reasoning text reported by the final generation step.
 
@@ -89,7 +101,7 @@ Concatenated reasoning text reported by the final generation step.
 readonly sources: readonly LanguageModelV4Source[];
 ```
 
-Defined in: [contracts/IIntelligenceTextCompletion.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L49)
+Defined in: [contracts/IIntelligenceTextCompletion.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L56)
 
 Sources reported by provider-native tools such as web search.
 
@@ -101,7 +113,7 @@ Sources reported by provider-native tools such as web search.
 readonly optional steps?: StepResult<ToolSet, Record<string, unknown>>[];
 ```
 
-Defined in: [contracts/IIntelligenceTextCompletion.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L77)
+Defined in: [contracts/IIntelligenceTextCompletion.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L84)
 
 All AI SDK generation steps.
 
@@ -125,7 +137,7 @@ The generated text content.
 readonly optional toolCalls?: TypedToolCall<ToolSet>[];
 ```
 
-Defined in: [contracts/IIntelligenceTextCompletion.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L91)
+Defined in: [contracts/IIntelligenceTextCompletion.ts:98](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L98)
 
 Tool calls produced across the generation.
 
@@ -137,7 +149,7 @@ Tool calls produced across the generation.
 readonly optional toolResults?: TypedToolResult<ToolSet>[];
 ```
 
-Defined in: [contracts/IIntelligenceTextCompletion.ts:98](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L98)
+Defined in: [contracts/IIntelligenceTextCompletion.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L105)
 
 Tool results produced across the generation.
 
@@ -151,7 +163,7 @@ readonly usage:
   | null;
 ```
 
-Defined in: [contracts/IIntelligenceTextCompletion.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L112)
+Defined in: [contracts/IIntelligenceTextCompletion.ts:119](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L119)
 
 Token usage telemetry, or `null` when the provider does not report usage.
 
@@ -163,6 +175,6 @@ Token usage telemetry, or `null` when the provider does not report usage.
 readonly optional warnings?: SharedV4Warning[];
 ```
 
-Defined in: [contracts/IIntelligenceTextCompletion.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L105)
+Defined in: [contracts/IIntelligenceTextCompletion.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L112)
 
 Provider or model warnings reported by the AI SDK.

package/data/packages/platform-intelligence/api/TypeAlias.IIntelligencePromptModelRequirement.md

@@ -0,0 +1,25 @@
+---
+title: 'Type Alias: IIntelligencePromptModelRequirement'
+generated: true
+editUrl: false
+---
+# Type Alias: IIntelligencePromptModelRequirement
+
+```ts
+type IIntelligencePromptModelRequirement = 
+  | {
+  strategy: "automatic";
+}
+  | {
+  models: ReadonlyArray<string>;
+  strategy: "preferred";
+}
+  | {
+  model: string | LanguageModel;
+  strategy: "fixed";
+};
+```
+
+Defined in: [prompts/IIntelligencePromptModelRequirement.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptModelRequirement.ts#L12)
+
+Model selection requested by a reusable intelligence prompt.

package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptCapability.md

@@ -0,0 +1,20 @@
+---
+title: 'Type Alias: IntelligencePromptCapability'
+generated: true
+editUrl: false
+---
+# Type Alias: IntelligencePromptCapability
+
+```ts
+type IntelligencePromptCapability = 
+  | "textInput"
+  | "imageInput"
+  | "textOutput"
+  | "structuredOutput"
+  | "toolCalling"
+  | "reasoning";
+```
+
+Defined in: [prompts/IntelligencePromptCapability.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptCapability.ts#L6)
+
+Provider-neutral capability required by an intelligence prompt.

package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptDefinitionConfiguration.md

@@ -0,0 +1,29 @@
+---
+title: 'Type Alias: IntelligencePromptDefinitionConfiguration\<TInput, TOutput\>'
+generated: true
+editUrl: false
+---
+# Type Alias: IntelligencePromptDefinitionConfiguration\<TInput, TOutput\>
+
+```ts
+type IntelligencePromptDefinitionConfiguration<TInput, TOutput> = 
+  | IIntelligencePromptDefinitionConfigurationBase<TInput> & {
+  mode: "text";
+  outputSchema?: never;
+}
+  | IIntelligencePromptDefinitionConfigurationBase<TInput> & {
+  mode: "object";
+  outputSchema: FlexibleSchema<TOutput>;
+};
+```
+
+Defined in: [prompts/IntelligencePromptDefinitionConfiguration.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptDefinitionConfiguration.ts#L23)
+
+Configuration accepted by [intelligencePrompt](Function.intelligencePrompt).
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TInput` |
+| `TOutput` |

package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptGenerationOptions.md

@@ -0,0 +1,16 @@
+---
+title: 'Type Alias: IntelligencePromptGenerationOptions'
+generated: true
+editUrl: false
+---
+# Type Alias: IntelligencePromptGenerationOptions
+
+```ts
+type IntelligencePromptGenerationOptions = Omit<IIntelligenceTextGenerationOptions, "output">;
+```
+
+Defined in: [prompts/IntelligencePromptGenerationOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptGenerationOptions.ts#L14)
+
+Native generation settings that can be stored on a prompt definition.
+
+The output contract is owned by the prompt mode and cannot be overridden.

package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptLatency.md

@@ -0,0 +1,14 @@
+---
+title: 'Type Alias: IntelligencePromptLatency'
+generated: true
+editUrl: false
+---
+# Type Alias: IntelligencePromptLatency
+
+```ts
+type IntelligencePromptLatency = "interactive" | "standard" | "background";
+```
+
+Defined in: [prompts/IntelligencePromptLatency.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptLatency.ts#L6)
+
+Latency profile requested by an intelligence prompt.

package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptMode.md

@@ -0,0 +1,14 @@
+---
+title: 'Type Alias: IntelligencePromptMode'
+generated: true
+editUrl: false
+---
+# Type Alias: IntelligencePromptMode
+
+```ts
+type IntelligencePromptMode = "text" | "object";
+```
+
+Defined in: [prompts/IntelligencePromptMode.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptMode.ts#L6)
+
+Supported execution modes for reusable intelligence prompts.

package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptQuality.md

@@ -0,0 +1,14 @@
+---
+title: 'Type Alias: IntelligencePromptQuality'
+generated: true
+editUrl: false
+---
+# Type Alias: IntelligencePromptQuality
+
+```ts
+type IntelligencePromptQuality = "economy" | "balanced" | "capable" | "premium";
+```
+
+Defined in: [prompts/IntelligencePromptQuality.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptQuality.ts#L6)
+
+Provider-neutral model quality requested by an intelligence prompt.

package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptReasoning.md

@@ -0,0 +1,14 @@
+---
+title: 'Type Alias: IntelligencePromptReasoning'
+generated: true
+editUrl: false
+---
+# Type Alias: IntelligencePromptReasoning
+
+```ts
+type IntelligencePromptReasoning = "none" | "minimal" | "low" | "medium" | "high";
+```
+
+Defined in: [prompts/IntelligencePromptReasoning.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptReasoning.ts#L6)
+
+Provider-neutral reasoning effort requested by an intelligence prompt.

package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeClientEvent.md

@@ -0,0 +1,64 @@
+---
+title: 'Type Alias: IntelligenceRealtimeClientEvent'
+generated: true
+editUrl: false
+---
+# Type Alias: IntelligenceRealtimeClientEvent
+
+```ts
+type IntelligenceRealtimeClientEvent = 
+  | {
+  config: IIntelligenceRealtimeSessionConfiguration;
+  type: "session-update";
+}
+  | {
+  audio: string;
+  type: "input-audio-append";
+}
+  | {
+  type: "input-audio-commit";
+}
+  | {
+  type: "input-audio-clear";
+}
+  | {
+  item:   | {
+     role: "user";
+     text: string;
+     type: "text-message";
+   }
+     | {
+     audio: string;
+     role: "user";
+     type: "audio-message";
+   }
+     | {
+     callId: string;
+     name?: string;
+     output: string;
+     type: "function-call-output";
+   };
+  type: "conversation-item-create";
+}
+  | {
+  audioEndMs: number;
+  contentIndex: number;
+  itemId: string;
+  type: "conversation-item-truncate";
+}
+  | {
+  options?: {
+     instructions?: string;
+     metadata?: Readonly<Record<string, unknown>>;
+     modalities?: ReadonlyArray<string>;
+  };
+  type: "response-create";
+}
+  | {
+  type: "response-cancel";
+};
+```
+
+Defined in: [realtime/contracts/IntelligenceRealtimeClientEvent.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IntelligenceRealtimeClientEvent.ts#L12)
+
+Provider-neutral event sent from an application to a realtime model.

package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMetadataValue.md

@@ -0,0 +1,14 @@
+---
+title: 'Type Alias: IntelligenceRealtimeMetadataValue'
+generated: true
+editUrl: false
+---
+# Type Alias: IntelligenceRealtimeMetadataValue
+
+```ts
+type IntelligenceRealtimeMetadataValue = string | number | boolean | null;
+```
+
+Defined in: [realtime/contracts/IntelligenceRealtimeMetadataValue.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IntelligenceRealtimeMetadataValue.ts#L6)
+
+Serializable metadata copied into realtime metering events.

package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMeteringEvent.md

@@ -0,0 +1,44 @@
+---
+title: 'Type Alias: IntelligenceRealtimeMeteringEvent'
+generated: true
+editUrl: false
+---
+# Type Alias: IntelligenceRealtimeMeteringEvent
+
+```ts
+type IntelligenceRealtimeMeteringEvent = 
+  | IIntelligenceRealtimeMeteringEnvelope & {
+  startedAt: string;
+  type: "session-started";
+}
+  | IIntelligenceRealtimeMeteringEnvelope & {
+  durationMs: number;
+  final: boolean;
+  periodEndedAt: string;
+  periodStartedAt: string;
+  sequence: number;
+  type: "billing-interval";
+}
+  | IIntelligenceRealtimeMeteringEnvelope & {
+  responseId: string | null;
+  type: "provider-usage";
+  usage: IIntelligenceRealtimeUsage;
+}
+  | IIntelligenceRealtimeMeteringEnvelope & {
+  closeCode: number;
+  closeReason: string;
+  durationMs: number;
+  endedAt: string;
+  startedAt: string;
+  type: "session-ended";
+};
+```
+
+Defined in: [realtime/contracts/IntelligenceRealtimeMeteringEvent.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IntelligenceRealtimeMeteringEvent.ts#L44)
+
+Durable metering event emitted by an Archipel realtime session.
+
+`billing-interval` events provide a provider-independent 30-second billing
+basis by default. `provider-usage` carries exact token dimensions whenever
+the upstream provider exposes them. Consumers can persist both in one audit
+transaction and choose their commercial charging strategy independently.

package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoader.md

@@ -0,0 +1,25 @@
+---
+title: 'Type Alias: IntelligenceRealtimeModelLoader'
+generated: true
+editUrl: false
+---
+# Type Alias: IntelligenceRealtimeModelLoader
+
+```ts
+type IntelligenceRealtimeModelLoader = (configuration, options) => Promise<RealtimeModelV4>;
+```
+
+Defined in: [providers/IntelligenceRealtimeModelLoader.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IntelligenceRealtimeModelLoader.ts#L14)
+
+Creates a configured Vercel AI SDK realtime model behind the Archipel facade.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) |
+| `options` | `IIntelligenceRealtimeModelLoaderOptions` |
+
+## Returns
+
+`Promise`\<`RealtimeModelV4`\>

package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoaders.md

@@ -0,0 +1,14 @@
+---
+title: 'Type Alias: IntelligenceRealtimeModelLoaders'
+generated: true
+editUrl: false
+---
+# Type Alias: IntelligenceRealtimeModelLoaders
+
+```ts
+type IntelligenceRealtimeModelLoaders = Partial<Record<IntelligenceProviderName, IntelligenceRealtimeModelLoader>>;
+```
+
+Defined in: [providers/IntelligenceRealtimeModelLoaders.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IntelligenceRealtimeModelLoaders.ts#L13)
+
+Maps configured intelligence providers to tree-shakable realtime model loaders.