signalwire-agents 0.1.0

package/dist/skills/builtin/wikipedia_search.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Wikipedia Search Skill - Searches Wikipedia for article summaries.
+ *
+ * Tier 3 built-in skill: no external API key required.
+ * Uses the Wikipedia REST API to fetch article summaries and extracts
+ * for any given topic.
+ */
+import { SkillBase } from '../SkillBase.js';
+import type { SkillManifest, SkillToolDefinition, SkillPromptSection, SkillConfig } from '../SkillBase.js';
+/**
+ * Searches Wikipedia for article summaries and extracts.
+ *
+ * Tier 3 built-in skill with no external API key required. Uses the Wikipedia
+ * REST API to fetch article summaries for any given topic, with a configurable
+ * number of sentences.
+ */
+export declare class WikipediaSearchSkill extends SkillBase {
+    /**
+     * @param config - Optional configuration (no config keys used by this skill).
+     */
+    constructor(config?: SkillConfig);
+    /** @returns Manifest with skill metadata (no required env vars). */
+    getManifest(): SkillManifest;
+    /** @returns A single `search_wikipedia` tool that fetches article summaries from Wikipedia. */
+    getTools(): SkillToolDefinition[];
+    /** @returns Prompt section describing Wikipedia search capabilities and usage guidance. */
+    getPromptSections(): SkillPromptSection[];
+}
+/**
+ * Factory function for creating WikipediaSearchSkill instances.
+ * @param config - Optional skill configuration.
+ * @returns A new WikipediaSearchSkill instance.
+ */
+export declare function createSkill(config?: SkillConfig): WikipediaSearchSkill;

package/dist/skills/builtin/wikipedia_search.js

@@ -0,0 +1,166 @@
+/**
+ * Wikipedia Search Skill - Searches Wikipedia for article summaries.
+ *
+ * Tier 3 built-in skill: no external API key required.
+ * Uses the Wikipedia REST API to fetch article summaries and extracts
+ * for any given topic.
+ */
+import { SkillBase } from '../SkillBase.js';
+import { SwaigFunctionResult } from '../../SwaigFunctionResult.js';
+/**
+ * Searches Wikipedia for article summaries and extracts.
+ *
+ * Tier 3 built-in skill with no external API key required. Uses the Wikipedia
+ * REST API to fetch article summaries for any given topic, with a configurable
+ * number of sentences.
+ */
+export class WikipediaSearchSkill extends SkillBase {
+    /**
+     * @param config - Optional configuration (no config keys used by this skill).
+     */
+    constructor(config) {
+        super('wikipedia_search', config);
+    }
+    /** @returns Manifest with skill metadata (no required env vars). */
+    getManifest() {
+        return {
+            name: 'wikipedia_search',
+            description: 'Searches Wikipedia for article summaries and extracts. No API key required.',
+            version: '1.0.0',
+            author: 'SignalWire',
+            tags: ['search', 'wikipedia', 'encyclopedia', 'knowledge', 'external'],
+        };
+    }
+    /** @returns A single `search_wikipedia` tool that fetches article summaries from Wikipedia. */
+    getTools() {
+        return [
+            {
+                name: 'search_wikipedia',
+                description: 'Search Wikipedia for information about a topic. Returns a summary of the most relevant article.',
+                parameters: {
+                    query: {
+                        type: 'string',
+                        description: 'The topic or term to search for on Wikipedia.',
+                    },
+                    sentences: {
+                        type: 'number',
+                        description: 'Number of sentences to return in the summary (1-10). Defaults to 3.',
+                    },
+                },
+                required: ['query'],
+                handler: async (args) => {
+                    const query = args.query;
+                    const sentences = args.sentences;
+                    if (!query || typeof query !== 'string' || query.trim().length === 0) {
+                        return new SwaigFunctionResult('Please provide a topic to search for on Wikipedia.');
+                    }
+                    const sentenceCount = Math.max(1, Math.min(10, sentences ?? 3));
+                    try {
+                        // First, try a direct page summary lookup
+                        const encodedQuery = encodeURIComponent(query.trim().replace(/\s+/g, '_'));
+                        const summaryUrl = `https://en.wikipedia.org/api/rest_v1/page/summary/${encodedQuery}`;
+                        const summaryResponse = await fetch(summaryUrl, {
+                            headers: { 'Accept': 'application/json', 'User-Agent': 'SignalWireAgentsSDK/1.0' },
+                        });
+                        if (summaryResponse.ok) {
+                            const data = (await summaryResponse.json());
+                            if (data.type !== 'disambiguation' && data.extract) {
+                                const extractSentences = data.extract.split(/(?<=[.!?])\s+/);
+                                const trimmedExtract = extractSentences
+                                    .slice(0, sentenceCount)
+                                    .join(' ')
+                                    .trim();
+                                const pageUrl = data.content_urls?.desktop?.page ?? '';
+                                const parts = [
+                                    `Wikipedia: ${data.title}`,
+                                ];
+                                if (data.description) {
+                                    parts.push(`(${data.description})`);
+                                }
+                                parts.push('');
+                                parts.push(trimmedExtract);
+                                if (pageUrl) {
+                                    parts.push('');
+                                    parts.push(`Read more: ${pageUrl}`);
+                                }
+                                return new SwaigFunctionResult(parts.join('\n').trim());
+                            }
+                        }
+                        // If direct lookup failed, use the search API
+                        const searchUrl = `https://en.wikipedia.org/w/rest.php/v1/search/page?q=${encodeURIComponent(query.trim())}&limit=1`;
+                        const searchResponse = await fetch(searchUrl, {
+                            headers: { 'Accept': 'application/json', 'User-Agent': 'SignalWireAgentsSDK/1.0' },
+                        });
+                        if (!searchResponse.ok) {
+                            return new SwaigFunctionResult(`Wikipedia search failed with status ${searchResponse.status}. Please try a different search term.`);
+                        }
+                        const searchData = (await searchResponse.json());
+                        if (!searchData.pages || searchData.pages.length === 0) {
+                            return new SwaigFunctionResult(`No Wikipedia article found for "${query}". Try a different search term.`);
+                        }
+                        // Fetch the summary for the best match
+                        const bestMatch = searchData.pages[0];
+                        const matchUrl = `https://en.wikipedia.org/api/rest_v1/page/summary/${encodeURIComponent(bestMatch.key)}`;
+                        const matchResponse = await fetch(matchUrl, {
+                            headers: { 'Accept': 'application/json', 'User-Agent': 'SignalWireAgentsSDK/1.0' },
+                        });
+                        if (!matchResponse.ok) {
+                            // Fall back to the search excerpt
+                            const excerpt = bestMatch.excerpt
+                                ? bestMatch.excerpt.replace(/<[^>]*>/g, '').trim()
+                                : 'No summary available.';
+                            return new SwaigFunctionResult(`Wikipedia: ${bestMatch.title}\n\n${excerpt}`);
+                        }
+                        const matchData = (await matchResponse.json());
+                        const extractSentences = matchData.extract.split(/(?<=[.!?])\s+/);
+                        const trimmedExtract = extractSentences
+                            .slice(0, sentenceCount)
+                            .join(' ')
+                            .trim();
+                        const pageUrl = matchData.content_urls?.desktop?.page ?? '';
+                        const parts = [`Wikipedia: ${matchData.title}`];
+                        if (matchData.description) {
+                            parts.push(`(${matchData.description})`);
+                        }
+                        parts.push('');
+                        parts.push(trimmedExtract);
+                        if (pageUrl) {
+                            parts.push('');
+                            parts.push(`Read more: ${pageUrl}`);
+                        }
+                        return new SwaigFunctionResult(parts.join('\n').trim());
+                    }
+                    catch (err) {
+                        const message = err instanceof Error ? err.message : String(err);
+                        return new SwaigFunctionResult(`Failed to search Wikipedia for "${query}": ${message}`);
+                    }
+                },
+            },
+        ];
+    }
+    /** @returns Prompt section describing Wikipedia search capabilities and usage guidance. */
+    getPromptSections() {
+        return [
+            {
+                title: 'Wikipedia Search',
+                body: 'You can search Wikipedia for information about any topic.',
+                bullets: [
+                    'Use the search_wikipedia tool when the user asks about a specific topic, person, place, or concept.',
+                    'Wikipedia provides encyclopedic summaries that are generally reliable for factual information.',
+                    'You can specify the number of sentences to return (1-10) for shorter or more detailed summaries.',
+                    'If a search returns no results, try rephrasing with the most common name or spelling.',
+                    'Summarize the information naturally rather than reading it verbatim.',
+                ],
+            },
+        ];
+    }
+}
+/**
+ * Factory function for creating WikipediaSearchSkill instances.
+ * @param config - Optional skill configuration.
+ * @returns A new WikipediaSearchSkill instance.
+ */
+export function createSkill(config) {
+    return new WikipediaSearchSkill(config);
+}
+//# sourceMappingURL=wikipedia_search.js.map

package/dist/skills/builtin/wikipedia_search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wikipedia_search.js","sourceRoot":"","sources":["../../../src/skills/builtin/wikipedia_search.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAO5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAyCnE;;;;;;GAMG;AACH,MAAM,OAAO,oBAAqB,SAAQ,SAAS;IACjD;;OAEG;IACH,YAAY,MAAoB;QAC9B,KAAK,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;IACpC,CAAC;IAED,oEAAoE;IACpE,WAAW;QACT,OAAO;YACL,IAAI,EAAE,kBAAkB;YACxB,WAAW,EACT,6EAA6E;YAC/E,OAAO,EAAE,OAAO;YAChB,MAAM,EAAE,YAAY;YACpB,IAAI,EAAE,CAAC,QAAQ,EAAE,WAAW,EAAE,cAAc,EAAE,WAAW,EAAE,UAAU,CAAC;SACvE,CAAC;IACJ,CAAC;IAED,+FAA+F;IAC/F,QAAQ;QACN,OAAO;YACL;gBACE,IAAI,EAAE,kBAAkB;gBACxB,WAAW,EACT,iGAAiG;gBACnG,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,WAAW,EACT,+CAA+C;qBAClD;oBACD,SAAS,EAAE;wBACT,IAAI,EAAE,QAAQ;wBACd,WAAW,EACT,qEAAqE;qBACxE;iBACF;gBACD,QAAQ,EAAE,CAAC,OAAO,CAAC;gBACnB,OAAO,EAAE,KAAK,EAAE,IAA6B,EAAE,EAAE;oBAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,KAA2B,CAAC;oBAC/C,MAAM,SAAS,GAAG,IAAI,CAAC,SAA+B,CAAC;oBAEvD,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBACrE,OAAO,IAAI,mBAAmB,CAC5B,oDAAoD,CACrD,CAAC;oBACJ,CAAC;oBAED,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,IAAI,CAAC,CAAC,CAAC,CAAC;oBAEhE,IAAI,CAAC;wBACH,0CAA0C;wBAC1C,MAAM,YAAY,GAAG,kBAAkB,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;wBAC3E,MAAM,UAAU,GAAG,qDAAqD,YAAY,EAAE,CAAC;wBAEvF,MAAM,eAAe,GAAG,MAAM,KAAK,CAAC,UAAU,EAAE;4BAC9C,OAAO,EAAE,EAAE,QAAQ,EAAE,kBAAkB,EAAE,YAAY,EAAE,yBAAyB,EAAE;yBACnF,CAAC,CAAC;wBAEH,IAAI,eAAe,CAAC,EAAE,EAAE,CAAC;4BACvB,MAAM,IAAI,GAAG,CAAC,MAAM,eAAe,CAAC,IAAI,EAAE,CAA6B,CAAC;4BAExE,IAAI,IAAI,CAAC,IAAI,KAAK,gBAAgB,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gCACnD,MAAM,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;gCAC7D,MAAM,cAAc,GAAG,gBAAgB;qCACpC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC;qCACvB,IAAI,CAAC,GAAG,CAAC;qCACT,IAAI,EAAE,CAAC;gCAEV,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,EAAE,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC;gCACvD,MAAM,KAAK,GAAa;oCACtB,cAAc,IAAI,CAAC,KAAK,EAAE;iCAC3B,CAAC;gCACF,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;oCACrB,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC;gCACtC,CAAC;gCACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gCACf,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gCAC3B,IAAI,OAAO,EAAE,CAAC;oCACZ,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;oCACf,KAAK,CAAC,IAAI,CAAC,cAAc,OAAO,EAAE,CAAC,CAAC;gCACtC,CAAC;gCAED,OAAO,IAAI,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;4BAC1D,CAAC;wBACH,CAAC;wBAED,8CAA8C;wBAC9C,MAAM,SAAS,GAAG,wDAAwD,kBAAkB,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC;wBAErH,MAAM,cAAc,GAAG,MAAM,KAAK,CAAC,SAAS,EAAE;4BAC5C,OAAO,EAAE,EAAE,QAAQ,EAAE,kBAAkB,EAAE,YAAY,EAAE,yBAAyB,EAAE;yBACnF,CAAC,CAAC;wBAEH,IAAI,CAAC,cAAc,CAAC,EAAE,EAAE,CAAC;4BACvB,OAAO,IAAI,mBAAmB,CAC5B,uCAAuC,cAAc,CAAC,MAAM,uCAAuC,CACpG,CAAC;wBACJ,CAAC;wBAED,MAAM,UAAU,GAAG,CAAC,MAAM,cAAc,CAAC,IAAI,EAAE,CAA4B,CAAC;wBAE5E,IAAI,CAAC,UAAU,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;4BACvD,OAAO,IAAI,mBAAmB,CAC5B,mCAAmC,KAAK,iCAAiC,CAC1E,CAAC;wBACJ,CAAC;wBAED,uCAAuC;wBACvC,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;wBACtC,MAAM,QAAQ,GAAG,qDAAqD,kBAAkB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;wBAE1G,MAAM,aAAa,GAAG,MAAM,KAAK,CAAC,QAAQ,EAAE;4BAC1C,OAAO,EAAE,EAAE,QAAQ,EAAE,kBAAkB,EAAE,YAAY,EAAE,yBAAyB,EAAE;yBACnF,CAAC,CAAC;wBAEH,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;4BACtB,kCAAkC;4BAClC,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO;gCAC/B,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE;gCAClD,CAAC,CAAC,uBAAuB,CAAC;4BAC5B,OAAO,IAAI,mBAAmB,CAC5B,cAAc,SAAS,CAAC,KAAK,OAAO,OAAO,EAAE,CAC9C,CAAC;wBACJ,CAAC;wBAED,MAAM,SAAS,GAAG,CAAC,MAAM,aAAa,CAAC,IAAI,EAAE,CAA6B,CAAC;wBAC3E,MAAM,gBAAgB,GAAG,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;wBAClE,MAAM,cAAc,GAAG,gBAAgB;6BACpC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC;6BACvB,IAAI,CAAC,GAAG,CAAC;6BACT,IAAI,EAAE,CAAC;wBAEV,MAAM,OAAO,GAAG,SAAS,CAAC,YAAY,EAAE,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC;wBAC5D,MAAM,KAAK,GAAa,CAAC,cAAc,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC;wBAC1D,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;4BAC1B,KAAK,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,WAAW,GAAG,CAAC,CAAC;wBAC3C,CAAC;wBACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;wBACf,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;wBAC3B,IAAI,OAAO,EAAE,CAAC;4BACZ,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;4BACf,KAAK,CAAC,IAAI,CAAC,cAAc,OAAO,EAAE,CAAC,CAAC;wBACtC,CAAC;wBAED,OAAO,IAAI,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;oBAC1D,CAAC;oBAAC,OAAO,GAAG,EAAE,CAAC;wBACb,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;wBACjE,OAAO,IAAI,mBAAmB,CAC5B,mCAAmC,KAAK,MAAM,OAAO,EAAE,CACxD,CAAC;oBACJ,CAAC;gBACH,CAAC;aACF;SACF,CAAC;IACJ,CAAC;IAED,2FAA2F;IAC3F,iBAAiB;QACf,OAAO;YACL;gBACE,KAAK,EAAE,kBAAkB;gBACzB,IAAI,EAAE,2DAA2D;gBACjE,OAAO,EAAE;oBACP,qGAAqG;oBACrG,gGAAgG;oBAChG,kGAAkG;oBAClG,uFAAuF;oBACvF,sEAAsE;iBACvE;aACF;SACF,CAAC;IACJ,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,MAAoB;IAC9C,OAAO,IAAI,oBAAoB,CAAC,MAAM,CAAC,CAAC;AAC1C,CAAC"}

package/dist/skills/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Skills framework for SignalWire AI Agents.
+ *
+ * Exports the base class, manager, registry, and all associated types
+ * needed to create, register, and manage agent skills.
+ */
+export { SkillBase } from './SkillBase.js';
+export type { SkillConfig, SkillToolDefinition, SkillPromptSection, SkillManifest } from './SkillBase.js';
+export { SkillManager } from './SkillManager.js';
+export { SkillRegistry } from './SkillRegistry.js';
+export type { SkillFactory } from './SkillRegistry.js';

package/dist/skills/index.js

@@ -0,0 +1,10 @@
+/**
+ * Skills framework for SignalWire AI Agents.
+ *
+ * Exports the base class, manager, registry, and all associated types
+ * needed to create, register, and manage agent skills.
+ */
+export { SkillBase } from './SkillBase.js';
+export { SkillManager } from './SkillManager.js';
+export { SkillRegistry } from './SkillRegistry.js';
+//# sourceMappingURL=index.js.map

package/dist/skills/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/skills/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Shared type definitions for SignalWire AI Agents SDK.
+ */
+/** Configuration options for constructing an AgentBase instance. */
+export interface AgentOptions {
+    /** Display name of the agent, also used as default basic-auth username when credentials are auto-generated. */
+    name: string;
+    /** HTTP route path the agent listens on (defaults to "/"). */
+    route?: string;
+    /** Hostname to bind the HTTP server to (defaults to "0.0.0.0"). */
+    host?: string;
+    /** Port number for the HTTP server (defaults to env PORT or 3000). */
+    port?: number;
+    /** Explicit basic-auth credentials as [username, password]; auto-generated if omitted. */
+    basicAuth?: [string, string];
+    /** Whether to use POM-based prompt rendering (defaults to true). */
+    usePom?: boolean;
+    /** Session token expiry in seconds (defaults to 3600). */
+    tokenExpirySecs?: number;
+    /** Whether to automatically insert an "answer" verb in the SWML call flow (defaults to true). */
+    autoAnswer?: boolean;
+    /** Whether to record the call (defaults to false). */
+    recordCall?: boolean;
+    /** Recording format, e.g. "mp4" (defaults to "mp4"). */
+    recordFormat?: string;
+    /** Whether to record in stereo (defaults to true). */
+    recordStereo?: boolean;
+    /** Default webhook URL for SWAIG function callbacks. */
+    defaultWebhookUrl?: string;
+    /** List of native function names to include in the SWAIG configuration. */
+    nativeFunctions?: string[];
+    /** Unique identifier for this agent instance; auto-generated if omitted. */
+    agentId?: string;
+    /** When true, suppresses all log output. */
+    suppressLogs?: boolean;
+}
+/** Configuration for a supported language in the AI agent. */
+export interface LanguageConfig {
+    /** Human-readable language name (e.g. "English"). */
+    name: string;
+    /** BCP-47 language code (e.g. "en-US"). */
+    code: string;
+    /** Voice identifier to use for this language. */
+    voice?: string;
+    /** TTS engine identifier. */
+    engine?: string;
+    /** Filler phrases keyed by category for this language. */
+    fillers?: Record<string, string[]>;
+    /** Speech recognition model identifier. */
+    speechModel?: string;
+    /** Per-function filler phrases, keyed by function name then language code. */
+    functionFillers?: Record<string, Record<string, string[]>>;
+}
+/** Rule for overriding how the TTS engine pronounces a specific word or phrase. */
+export interface PronunciationRule {
+    /** The text pattern to match. */
+    replace: string;
+    /** The replacement pronunciation. */
+    with: string;
+    /** Whether the match should be case-insensitive. */
+    ignoreCase?: boolean;
+}
+/** Reference to an external SWAIG function endpoint to include in the AI configuration. */
+export interface FunctionInclude {
+    /** URL of the remote SWAIG endpoint. */
+    url: string;
+    /** List of function names available at the remote endpoint. */
+    functions: string[];
+    /** Optional metadata to pass along with the include. */
+    meta_data?: Record<string, unknown>;
+}
+/**
+ * Callback invoked on each SWML request to dynamically modify an ephemeral copy of the agent.
+ * @param queryParams - URL query parameters from the incoming request.
+ * @param bodyParams - Parsed JSON body of the incoming request.
+ * @param headers - HTTP headers from the incoming request.
+ * @param agent - Ephemeral AgentBase copy that can be mutated without affecting the original.
+ */
+export type DynamicConfigCallback = (queryParams: Record<string, string>, bodyParams: Record<string, unknown>, headers: Record<string, string>, agent: unknown) => void | Promise<void>;
+/**
+ * Callback invoked when a post-prompt summary is received at the end of a call.
+ * @param summary - Parsed summary object, or null if extraction failed.
+ * @param rawData - The full raw post-prompt payload.
+ */
+export type SummaryCallback = (summary: Record<string, unknown> | null, rawData: Record<string, unknown>) => void | Promise<void>;

package/dist/types.js

@@ -0,0 +1,5 @@
+/**
+ * Shared type definitions for SignalWire AI Agents SDK.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG"}