npm - @genesislcap/foundation-ai - Versions diffs - 14.408.0 → 14.409.0 - Mend

@genesislcap/foundation-ai 14.408.0 → 14.409.0

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 (120) hide show

package/docs/api/foundation-ai.md DELETED Viewed

@@ -1,503 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md)
-## foundation-ai package
-## Classes
-<table><thead><tr><th>
-Class
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[GeminiProvider](./foundation-ai.geminiprovider.md)
-</td><td>
-**_(BETA)_** Gemini AI provider. Uses [GeminiTransport](./foundation-ai.geminitransport.md) to handle requests. Implements criteria interpretation and multi-turn chat.
-</td></tr>
-<tr><td>
-[GeminiTransport](./foundation-ai.geminitransport.md)
-</td><td>
-**_(BETA)_** Transport for Gemini. Calls the Gemini REST API directly when `apiKey` is provided, otherwise falls back to a server-proxy endpoint (if `serverEndpoint` is configured).
-Implements `AITransport` (structured prompt) and `ChatTransport` (multi-turn chat).
-</td></tr>
-<tr><td>
-[MalformedFunctionCallError](./foundation-ai.malformedfunctioncallerror.md)
-</td><td>
-**_(BETA)_** Thrown when Gemini returns a `MALFORMED_FUNCTION_CALL` finish reason, typically because the model tried to batch multiple tool calls using Python-style syntax instead of the proper API format.
-</td></tr>
-</tbody></table>
-## Functions
-<table><thead><tr><th>
-Function
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[createAIProvider(config)](./foundation-ai.createaiprovider.md)
-</td><td>
-**_(BETA)_** Creates an AIProvider from config. Uses ChromeProvider when providerType is 'chrome'. Uses OpenAIProvider with ServerOpenAITransport when provider is set (server-only). Otherwise returns DefaultAIProvider. When the AI feature flag is disabled (?feature.ai), always returns DefaultAIProvider.
-</td></tr>
-<tr><td>
-[getAIProvider()](./foundation-ai.getaiprovider.md)
-</td><td>
-**_(BETA)_** Gets AIProvider from the DI container. When the AI feature flag is disabled (?feature.ai), returns DefaultAIProvider (no-op).
-</td></tr>
-<tr><td>
-[isAIFeatureEnabled()](./foundation-ai.isaifeatureenabled.md)
-</td><td>
-Returns true when AI features (beta) are enabled. Requires ?feature.ai in URL.
-</td></tr>
-<tr><td>
-[isSpeechRecognitionAvailable()](./foundation-ai.isspeechrecognitionavailable.md)
-</td><td>
-**_(BETA)_** Returns true if the Web Speech API is available in the current environment.
-</td></tr>
-<tr><td>
-[resolveAIConfig(options)](./foundation-ai.resolveaiconfig.md)
-</td><td>
-**_(BETA)_** Resolves AI config, optionally preferring Chrome when available. Use before registering AIProvider. Server URL is derived from API\_HOST. Returns null when the AI feature flag is disabled (?feature.ai).
-</td></tr>
-<tr><td>
-[startSpeechRecognition(onResult, onError)](./foundation-ai.startspeechrecognition.md)
-</td><td>
-**_(BETA)_** Starts continuous speech recognition, calling `onResult` with each transcript update. Returns a stop function, or null if speech recognition is unavailable.
-</td></tr>
-</tbody></table>
-## Interfaces
-<table><thead><tr><th>
-Interface
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[AIProvider](./foundation-ai.aiprovider.md)
-</td><td>
-**_(BETA)_** AI Provider interface for foundation-ai.
-</td></tr>
-<tr><td>
-[AIStatus](./foundation-ai.aistatus.md)
-</td><td>
-**_(BETA)_** AI status for display in the header indicator.
-</td></tr>
-<tr><td>
-[ChatAnimationsConfig](./foundation-ai.chatanimationsconfig.md)
-</td><td>
-**_(BETA)_** Configuration for the animations feature.
-</td></tr>
-<tr><td>
-[ChatAttachment](./foundation-ai.chatattachment.md)
-</td><td>
-**_(BETA)_** A file attachment included with a user message.
-</td></tr>
-<tr><td>
-[ChatConfig](./foundation-ai.chatconfig.md)
-</td><td>
-**_(BETA)_** Display and behaviour configuration for the chat assistant.
-For toggle flags (`showToolCalls`<!-- -->, `showThinkingSteps`<!-- -->): - `true` — default on, user can toggle off - `false` — default off, user can toggle on - `null` / `undefined` — completely disabled, no UI control shown
-</td></tr>
-<tr><td>
-[ChatInteraction](./foundation-ai.chatinteraction.md)
-</td><td>
-**_(BETA)_** A user interaction component request.
-</td></tr>
-<tr><td>
-[ChatMessage](./foundation-ai.chatmessage.md)
-</td><td>
-**_(BETA)_** A single message in a chat conversation.
-</td></tr>
-<tr><td>
-[ChatRequestOptions](./foundation-ai.chatrequestoptions.md)
-</td><td>
-**_(BETA)_** Options for a chat request.
-</td></tr>
-<tr><td>
-[ChatStreamChunk](./foundation-ai.chatstreamchunk.md)
-</td><td>
-**_(BETA)_** A streaming chunk from a chat response.
-</td></tr>
-<tr><td>
-[ChatToolCall](./foundation-ai.chattoolcall.md)
-</td><td>
-**_(BETA)_** A tool call requested by the assistant.
-</td></tr>
-<tr><td>
-[ChatToolDefinition](./foundation-ai.chattooldefinition.md)
-</td><td>
-**_(BETA)_** JSON Schema-based tool definition for function calling.
-</td></tr>
-<tr><td>
-[ChatToolResult](./foundation-ai.chattoolresult.md)
-</td><td>
-**_(BETA)_** The result of executing a tool call.
-</td></tr>
-<tr><td>
-[ChatTransport](./foundation-ai.chattransport.md)
-</td><td>
-**_(BETA)_** Transport interface for chat-capable AI providers.
-</td></tr>
-<tr><td>
-[ChromeAIConfig](./foundation-ai.chromeaiconfig.md)
-</td><td>
-**_(BETA)_** Chrome built-in AI (Prompt API / Gemini Nano) configuration.
-</td></tr>
-<tr><td>
-[CriteriaClauseResult](./foundation-ai.criteriaclauseresult.md)
-</td><td>
-**_(BETA)_** Minimal types for AI criteria interpretation results. Providers return these; consumers (e.g. ai-criteria-search) validate and cast.
-</td></tr>
-<tr><td>
-[CriteriaGroupResult](./foundation-ai.criteriagroupresult.md)
-</td><td>
-**_(BETA)_** A group of criteria clauses combined by a logical operator.
-</td></tr>
-<tr><td>
-[CriteriaInterpretationResult](./foundation-ai.criteriainterpretationresult.md)
-</td><td>
-**_(BETA)_** Top-level result returned by criteria interpretation.
-</td></tr>
-<tr><td>
-[CriteriaInterpretContext](./foundation-ai.criteriainterpretcontext.md)
-</td><td>
-**_(BETA)_** Context passed to criteria interpretation, providing available field metadata.
-</td></tr>
-<tr><td>
-[GeminiAIConfig](./foundation-ai.geminiaiconfig.md)
-</td><td>
-**_(BETA)_** Gemini server-proxy AI configuration (client calls your server; server calls Gemini).
-</td></tr>
-<tr><td>
-[ResolveAIConfigOptions](./foundation-ai.resolveaiconfigoptions.md)
-</td><td>
-**_(BETA)_** Options for [resolveAIConfig()](./foundation-ai.resolveaiconfig.md)<!-- -->.
-</td></tr>
-<tr><td>
-[ServerAIConfig](./foundation-ai.serveraiconfig.md)
-</td><td>
-**_(BETA)_** Server-proxy AI configuration (client calls your server; server calls the provider).
-</td></tr>
-</tbody></table>
-## Variables
-<table><thead><tr><th>
-Variable
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[AI\_FEATURE\_FLAG](./foundation-ai.ai_feature_flag.md)
-</td><td>
-Feature flag name for AI functionality (beta). Enable via ?feature.ai in URL.
-</td></tr>
-</tbody></table>
-## Type Aliases
-<table><thead><tr><th>
-Type Alias
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[AIConfig](./foundation-ai.aiconfig.md)
-</td><td>
-**_(BETA)_** Union type for provider-specific configs. Extend when adding new providers.
-</td></tr>
-<tr><td>
-[AIProviderType](./foundation-ai.aiprovidertype.md)
-</td><td>
-**_(BETA)_** All AI provider identifiers (server, client, unconfigured).
-</td></tr>
-<tr><td>
-[ChatRole](./foundation-ai.chatrole.md)
-</td><td>
-**_(BETA)_** Role of a message in a chat conversation.
-</td></tr>
-<tr><td>
-[ChatToolHandlers](./foundation-ai.chattoolhandlers.md)
-</td><td>
-**_(BETA)_** Map of tool name to async handler function.
-</td></tr>
-<tr><td>
-[ChromeAvailability](./foundation-ai.chromeavailability.md)
-</td><td>
-**_(BETA)_** Chrome Prompt API availability states.
-</td></tr>
-<tr><td>
-[FieldLike](./foundation-ai.fieldlike.md)
-</td><td>
-**_(BETA)_** A field descriptor accepted by criteria interpretation utilities. Can be a plain string name or an object with common field metadata properties.
-</td></tr>
-<tr><td>
-[InteractionResult](./foundation-ai.interactionresult.md)
-</td><td>
-**_(BETA)_** The result of a user interaction component.
-</td></tr>
-</tbody></table>

package/docs/api/foundation-ai.resolveaiconfig.md DELETED Viewed

@@ -1,57 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [resolveAIConfig](./foundation-ai.resolveaiconfig.md)
-## resolveAIConfig() function
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-Resolves AI config, optionally preferring Chrome when available. Use before registering AIProvider. Server URL is derived from API\_HOST. Returns null when the AI feature flag is disabled (?feature.ai).
-**Signature:**
-```typescript
-export declare function resolveAIConfig(options?: ResolveAIConfigOptions): Promise<AIConfig | null>;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-options
-</td><td>
-[ResolveAIConfigOptions](./foundation-ai.resolveaiconfigoptions.md)
-</td><td>
-_(Optional)_
-</td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;[AIConfig](./foundation-ai.aiconfig.md) \| null&gt;

package/docs/api/foundation-ai.resolveaiconfigoptions.md DELETED Viewed

@@ -1,99 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ResolveAIConfigOptions](./foundation-ai.resolveaiconfigoptions.md)
-## ResolveAIConfigOptions interface
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-Options for [resolveAIConfig()](./foundation-ai.resolveaiconfig.md)<!-- -->.
-**Signature:**
-```typescript
-export interface ResolveAIConfigOptions
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[model?](./foundation-ai.resolveaiconfigoptions.model.md)
-</td><td>
-</td><td>
-string
-</td><td>
-**_(BETA)_** _(Optional)_ Model name (e.g. gpt-4o-mini). Default: gpt-4o-mini
-</td></tr>
-<tr><td>
-[preferChrome?](./foundation-ai.resolveaiconfigoptions.preferchrome.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-**_(BETA)_** _(Optional)_ Prefer Chrome built-in AI when available
-</td></tr>
-<tr><td>
-[provider?](./foundation-ai.resolveaiconfigoptions.provider.md)
-</td><td>
-</td><td>
-'openai' \| 'gemini'
-</td><td>
-**_(BETA)_** _(Optional)_ Cloud provider (openai, gemini). Default: openai
-</td></tr>
-</tbody></table>

package/docs/api/foundation-ai.resolveaiconfigoptions.model.md DELETED Viewed

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ResolveAIConfigOptions](./foundation-ai.resolveaiconfigoptions.md) &gt; [model](./foundation-ai.resolveaiconfigoptions.model.md)
-## ResolveAIConfigOptions.model property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-Model name (e.g. gpt-4o-mini). Default: gpt-4o-mini
-**Signature:**
-```typescript
-model?: string;
-```

package/docs/api/foundation-ai.resolveaiconfigoptions.preferchrome.md DELETED Viewed

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ResolveAIConfigOptions](./foundation-ai.resolveaiconfigoptions.md) &gt; [preferChrome](./foundation-ai.resolveaiconfigoptions.preferchrome.md)
-## ResolveAIConfigOptions.preferChrome property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-Prefer Chrome built-in AI when available
-**Signature:**
-```typescript
-preferChrome?: boolean;
-```

package/docs/api/foundation-ai.resolveaiconfigoptions.provider.md DELETED Viewed

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ResolveAIConfigOptions](./foundation-ai.resolveaiconfigoptions.md) &gt; [provider](./foundation-ai.resolveaiconfigoptions.provider.md)
-## ResolveAIConfigOptions.provider property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-Cloud provider (openai, gemini). Default: openai
-**Signature:**
-```typescript
-provider?: 'openai' | 'gemini';
-```