@falai/agent 0.8.1 → 0.9.0-alpha-1

package/examples/domain-scoping.ts

@@ -1,366 +0,0 @@
-/**
- * Domain Scoping Example
- * Updated for v2 architecture with session step management
- *
- * This example demonstrates how to use domain scoping to restrict which tools
- * can EXECUTE in different conversation routes for security and isolation.
- *
- * Important: Domains are OPTIONAL. If you never use domains, all tools are
- * available everywhere. Use domains when you need security and organization.
- *
- * Key Concept: The AI never sees tools. Domains control which tools can
- * execute automatically when triggered by the step machine or guidelines.
- */
-
-import {
-  Agent,
-  createMessageEvent,
-  EventSource,
-  createSession,
-  END_ROUTE,
-  defineTool,
-} from "../src/index";
-import { OpenRouterProvider } from "../src/providers";
-
-// Initialize AI provider
-const provider = new OpenRouterProvider({
-  apiKey: process.env.OPENROUTER_API_KEY || "your-api-key-here",
-  model: "google/gemini-2.0-flash-exp",
-  backupModels: ["anthropic/claude-sonnet-4-5"],
-});
-
-// Create agent
-const agent = new Agent({
-  name: "Multi-Domain Assistant",
-  description:
-    "An assistant that handles different tasks with domain-scoped tools",
-  provider,
-});
-
-// Register different domains with their tools
-agent.addDomain("scraping", {
-  scrapeSite: async (url: string) => {
-    console.log(`[Scraping] Scraping site: ${url}`);
-    return { success: true, data: "Scraped content..." };
-  },
-  extractData: async (html: string, selector: string) => {
-    console.log(`[Scraping] Extracting data with selector: ${selector}`);
-    return { elements: [] };
-  },
-});
-
-agent.addDomain("calendar", {
-  scheduleEvent: async (date: Date, title: string, description?: string) => {
-    console.log(`[Calendar] Scheduling event: ${title} on ${date}`);
-    return { eventId: "evt_123", success: true };
-  },
-  listEvents: async (startDate: Date, endDate: Date) => {
-    console.log(`[Calendar] Listing events from ${startDate} to ${endDate}`);
-    return { events: [] };
-  },
-  cancelEvent: async (eventId: string) => {
-    console.log(`[Calendar] Cancelling event: ${eventId}`);
-    return { success: true };
-  },
-});
-
-agent.addDomain("payment", {
-  processPayment: async (amount: number, currency: string) => {
-    console.log(`[Payment] Processing payment: ${amount} ${currency}`);
-    return { transactionId: "txn_456", success: true };
-  },
-  refund: async (transactionId: string) => {
-    console.log(`[Payment] Processing refund for: ${transactionId}`);
-    return { success: true };
-  },
-  checkBalance: async () => {
-    console.log(`[Payment] Checking balance`);
-    return { balance: 1000, currency: "USD" };
-  },
-});
-
-agent.addDomain("analytics", {
-  trackEvent: async (
-    eventName: string,
-    properties: Record<string, unknown>
-  ) => {
-    console.log(`[Analytics] Tracking event: ${eventName}`, properties);
-    return { success: true };
-  },
-  generateReport: async (
-    reportType: string,
-    dateRange: { start: Date; end: Date }
-  ) => {
-    console.log(`[Analytics] Generating ${reportType} report`);
-    return { report: {} };
-  },
-});
-
-// Create routes with domain scoping
-agent.createRoute({
-  title: "Data Collection",
-  description: "Collect and process web data",
-  conditions: ["User wants to scrape or extract data from websites"],
-  domains: ["scraping"], // ✅ Only scraping tools available
-});
-
-const scheduleEventTool = defineTool({
-  id: "scheduleEvent",
-  name: "scheduleEvent",
-  description: "Schedules an event in the calendar",
-  handler: async ({ data }) => {
-    const { title, date, description } = data as {
-      title: string;
-      date: string;
-      description: string;
-    };
-    console.log(`[Calendar] Scheduling event: ${title} on ${date}`);
-    return { data: { eventId: "evt_123", success: true } };
-  },
-});
-
-agent.createRoute<{ title: string; date: string; description: string }>({
-  title: "Schedule Meeting",
-  description: "Book and manage appointments",
-  conditions: ["User wants to schedule, view, or cancel events"],
-  domains: ["calendar"], // ✅ Only calendar tools available
-  schema: {
-    type: "object",
-    properties: {
-      title: { type: "string" },
-      date: { type: "string" },
-      description: { type: "string" },
-    },
-    required: ["title", "date"],
-  },
-  steps: [
-    {
-      instructions: "What is the title of the meeting?",
-      collect: ["title"],
-    },
-    {
-      instructions: "When would you like to schedule it?",
-      collect: ["date"],
-    },
-    {
-      instructions: "Any description for the meeting?",
-      collect: ["description"],
-    },
-    {
-      tool: scheduleEventTool,
-    },
-    {
-      instructions: "The meeting has been scheduled.",
-    },
-  ],
-});
-
-agent.createRoute({
-  title: "Checkout Process",
-  description: "Process purchases and payments",
-  conditions: ["User wants to make a purchase or payment"],
-  domains: ["payment", "analytics"], // ✅ Multiple domains allowed
-});
-
-agent.createRoute({
-  title: "Customer Support",
-  description: "Answer general questions and provide help",
-  conditions: ["User has general questions or needs support"],
-  domains: [], // ✅ No tools available (conversation only)
-});
-
-agent.createRoute({
-  title: "Admin Support",
-  description: "Administrative tasks with full access",
-  conditions: ["User is admin and needs full system access"],
-  // domains not specified = all domains available
-});
-
-// Example conversations
-async function demonstrateScoping() {
-  console.log("\n=== Domain Scoping Demo ===\n");
-
-  // Example 1: Data Collection route - only scraping tools available
-  console.log("1️⃣  Example: User wants to scrape data");
-  const history1 = [
-    createMessageEvent({
-      source: EventSource.CUSTOMER,
-      participantName: "Alice",
-      message: "Can you scrape the homepage of example.com?",
-    }),
-  ];
-
-  // Initialize session step for multi-turn conversation
-  let session = createSession();
-
-  const response1 = await agent.respond({ history: history1, session });
-  console.log(`Route chosen: ${response1.session?.currentRoute?.title}`);
-  console.log(`Available tools in this route: scraping only`);
-  console.log(`Response: ${response1.message}\n`);
-
-  // Update session with progress
-  session = response1.session!;
-
-  // Example 2: Schedule Meeting route - only calendar tools available
-  console.log("2️⃣  Example: User wants to schedule a meeting");
-  const history2 = [
-    createMessageEvent({
-      source: EventSource.CUSTOMER,
-      participantName: "Bob",
-      message: "Schedule a meeting for tomorrow at 2pm",
-    }),
-  ];
-
-  const response2 = await agent.respond({ history: history2, session });
-  console.log(`Route chosen: ${response2.session?.currentRoute?.title}`);
-  console.log(`Available tools in this route: calendar only`);
-  console.log(`Response: ${response2.message}\n`);
-
-  if (response2.isRouteComplete) {
-    console.log("\n✅ Meeting scheduling complete!");
-    await sendMeetingInvite(
-      agent.getData(response2.session?.id) as {
-        title: string;
-        date: string;
-      }
-    );
-  }
-
-  // Update session again
-  session = response2.session!;
-
-  // Example 3: Customer Support route - NO tools available
-  console.log("3️⃣  Example: User has a general question");
-  const history3 = [
-    createMessageEvent({
-      source: EventSource.CUSTOMER,
-      participantName: "Charlie",
-      message: "What are your business hours?",
-    }),
-  ];
-
-  const response3 = await agent.respond({ history: history3, session });
-  console.log(`Route chosen: ${response3.session?.currentRoute?.title}`);
-  console.log(`Available tools in this route: none (conversation only)`);
-  console.log(`Response: ${response3.message}\n`);
-
-  // Update session again
-  session = response3.session!;
-
-  // Example 4: Admin Support route - ALL tools available (for demo purposes)
-  console.log("4️⃣  Example: Admin needs full access");
-  const history4 = [
-    createMessageEvent({
-      source: EventSource.CUSTOMER,
-      participantName: "Admin",
-      message: "I need to generate a report and process a refund",
-    }),
-  ];
-
-  const response4 = await agent.respond({ history: history4, session });
-  console.log(`Route chosen: ${response4.session?.currentRoute?.title}`);
-  console.log(`Available tools in this route: all domains`);
-  console.log(`Response: ${response4.message}\n`);
-}
-
-// Benefits demonstration
-console.log(`
-🔒 Security Benefits (V2 Architecture):
-- Customer Support route cannot execute payment.processPayment()
-- Data Collection route cannot execute calendar.scheduleEvent()
-- Each route has minimum necessary tool permissions
-- Prevents prompt injection attacks from calling sensitive tools
-- Session step ensures domain scoping persists across turns
-
-🎯 Isolation Benefits:
-- Route execution is isolated - tools can't cross boundaries
-- Checkout can't accidentally trigger admin operations
-- Clear separation of concerns by capability
-- Always-on routing maintains domain restrictions
-
-📋 Clarity Benefits:
-- Routes clearly document their capabilities
-- Easy to audit what each route can execute
-- Better debugging when tools are called
-- Self-documenting security model
-- Session step tracks domain-scoped conversations
-`);
-
-// Inspect route configurations
-console.log("\n📋 Route Configurations:\n");
-for (const route of agent.getRoutes()) {
-  const domains = route.getDomains();
-  const domainsText =
-    domains === undefined
-      ? "all domains"
-      : domains.length === 0
-      ? "no tools (conversation only)"
-      : domains.join(", ");
-
-  console.log(`• ${route.title}: ${domainsText}`);
-}
-
-// Validate tool calls (example helper function)
-function validateToolCall(toolName: string, routeTitle: string): boolean {
-  const route = agent.getRoutes().find((r) => r.title === routeTitle);
-  if (!route) return false;
-
-  const allowedDomains = route.getDomains();
-
-  // If undefined, all domains allowed
-  if (allowedDomains === undefined) return true;
-
-  // If empty array, no tools allowed
-  if (allowedDomains.length === 0) return false;
-
-  // Check if tool's domain is in allowed list
-  const [domain] = toolName.split(".");
-  return allowedDomains.includes(domain);
-}
-
-console.log("\n✅ Validation Examples:");
-console.log(
-  `- scraping.scrapeSite in "Data Collection": ${validateToolCall(
-    "scraping.scrapeSite",
-    "Data Collection"
-  )}`
-);
-console.log(
-  `- calendar.scheduleEvent in "Data Collection": ${validateToolCall(
-    "calendar.scheduleEvent",
-    "Data Collection"
-  )}`
-);
-console.log(
-  `- payment.processPayment in "Customer Support": ${validateToolCall(
-    "payment.processPayment",
-    "Customer Support"
-  )}`
-);
-console.log(
-  `- analytics.trackEvent in "Admin Support": ${validateToolCall(
-    "analytics.trackEvent",
-    "Admin Support"
-  )}`
-);
-
-/**
- * Mock function to send a meeting invite.
- * @param data - The meeting data.
- */
-async function sendMeetingInvite(data: { title: string; date: string }) {
-  console.log("\n" + "=".repeat(60));
-  console.log("🚀 Sending Meeting Invite...");
-  console.log("=".repeat(60));
-  console.log("Meeting Details:", JSON.stringify(data, null, 2));
-  console.log(`   - Sending invite for "${data.title}" on ${data.date}.`);
-  await new Promise((resolve) => setTimeout(resolve, 1000));
-  console.log("✨ Invite sent!");
-}
-
-// Run demonstration
-if (import.meta.url === `file://${process.argv[1]}`) {
-  demonstrateScoping().catch(console.error);
-}
-
-export { agent };