convoai 1.5.3 → 1.6.1

package/src/starters/web/server/routes/callback.ts

@@ -0,0 +1,13 @@
+// Webhook endpoint for ConvoAI Engine callbacks.
+// Customize: add your webhook handling logic here.
+
+import { Router } from 'express';
+
+const router = Router();
+
+router.post('/callback', (req, res) => {
+  console.log('[callback] Received webhook:', JSON.stringify(req.body, null, 2));
+  res.json({ received: true });
+});
+
+export default router;

package/src/starters/web/server/routes/knowledge.ts

@@ -0,0 +1,19 @@
+// Knowledge base query endpoint.
+// Customize: connect your knowledge base, RAG pipeline, or vector DB here.
+
+import { Router } from 'express';
+
+const router = Router();
+
+router.post('/knowledge', (req, res) => {
+  const { query } = req.body || {};
+  console.log('[knowledge] Query:', query);
+
+  // Customize: replace with your knowledge base integration
+  res.json({
+    results: [],
+    message: 'Knowledge base not configured. Edit server/routes/knowledge.ts to connect yours.',
+  });
+});
+
+export default router;

package/src/starters/web/server/routes/session.ts

@@ -0,0 +1,122 @@
+import { Router } from 'express';
+import { startAgent, stopAgent, interruptAgent, type StartAgentConfig } from '../convoai-api.js';
+
+const router = Router();
+
+// In-memory session store (single session for simplicity)
+// Customize: replace with database or Redis for production
+let currentSession: { agentId: string; channel: string } | null = null;
+
+router.post('/session/start', async (req, res) => {
+  try {
+    if (currentSession) {
+      res.status(409).json({ error: 'Session already active. Stop it first.' });
+      return;
+    }
+
+    // Validate required credentials before attempting API calls
+    const required = ['AGORA_APP_ID', 'AGORA_APP_CERTIFICATE', 'AGORA_CUSTOMER_ID', 'AGORA_CUSTOMER_SECRET'];
+    const missing = required.filter(k => !process.env[k]);
+    if (missing.length > 0) {
+      res.status(503).json({
+        error: `Missing credentials: ${missing.join(', ')}. Edit .env and restart the server.`,
+      });
+      return;
+    }
+
+    const appId = process.env.AGORA_APP_ID!;
+    const appCertificate = process.env.AGORA_APP_CERTIFICATE!;
+    const customerId = process.env.AGORA_CUSTOMER_ID!;
+    const customerSecret = process.env.AGORA_CUSTOMER_SECRET!;
+    const region = process.env.AGORA_REGION || 'global';
+
+    const channel = `session-${Date.now().toString(36)}`;
+    const clientUid = Math.floor(Math.random() * 90000) + 10000;
+
+    const config: StartAgentConfig = {
+      appId,
+      appCertificate,
+      customerId,
+      customerSecret,
+      region,
+      channel,
+      clientUid,
+      llm: {
+        vendor: process.env.LLM_VENDOR,
+        model: process.env.LLM_MODEL,
+        apiKey: process.env.LLM_API_KEY,
+        url: process.env.LLM_URL,
+        style: process.env.LLM_STYLE,
+      },
+      tts: {
+        vendor: process.env.TTS_VENDOR,
+        params: process.env.TTS_PARAMS ? JSON.parse(process.env.TTS_PARAMS) : {},
+      },
+      asr: {
+        vendor: process.env.ASR_VENDOR,
+        language: process.env.ASR_LANGUAGE,
+      },
+    };
+
+    const result = await startAgent(config);
+    currentSession = { agentId: result.agentId, channel: result.channel };
+
+    res.json({
+      appId: result.appId,
+      channel: result.channel,
+      token: result.token,
+      uid: result.uid,
+      agentId: result.agentId,
+    });
+  } catch (err: unknown) {
+    const message = err instanceof Error ? err.message : 'Unknown error';
+    console.error('[session/start]', message);
+    res.status(500).json({ error: message });
+  }
+});
+
+router.post('/session/stop', async (req, res) => {
+  try {
+    if (!currentSession) {
+      res.status(404).json({ error: 'No active session' });
+      return;
+    }
+
+    const appId = process.env.AGORA_APP_ID!;
+    const customerId = process.env.AGORA_CUSTOMER_ID!;
+    const customerSecret = process.env.AGORA_CUSTOMER_SECRET!;
+    const region = process.env.AGORA_REGION || 'global';
+
+    await stopAgent(appId, currentSession.agentId, customerId, customerSecret, region);
+    currentSession = null;
+
+    res.json({ status: 'stopped' });
+  } catch (err: unknown) {
+    const message = err instanceof Error ? err.message : 'Unknown error';
+    console.error('[session/stop]', message);
+    currentSession = null;
+    res.status(500).json({ error: message });
+  }
+});
+
+router.post('/session/interrupt', async (req, res) => {
+  try {
+    if (!currentSession) {
+      res.status(404).json({ error: 'No active session' });
+      return;
+    }
+
+    const appId = process.env.AGORA_APP_ID!;
+    const customerId = process.env.AGORA_CUSTOMER_ID!;
+    const customerSecret = process.env.AGORA_CUSTOMER_SECRET!;
+    const region = process.env.AGORA_REGION || 'global';
+
+    await interruptAgent(appId, currentSession.agentId, customerId, customerSecret, region);
+    res.json({ status: 'interrupted' });
+  } catch (err: unknown) {
+    const message = err instanceof Error ? err.message : 'Unknown error';
+    res.status(500).json({ error: message });
+  }
+});
+
+export default router;

package/src/starters/web/server/routes/token.ts

@@ -0,0 +1,22 @@
+import { Router } from 'express';
+import { generateToken } from '../convoai-api.js';
+
+const router = Router();
+
+router.get('/token', (req, res) => {
+  try {
+    const appId = process.env.AGORA_APP_ID!;
+    const appCertificate = process.env.AGORA_APP_CERTIFICATE!;
+    const channel = (req.query.channel as string) || `ch-${Date.now().toString(36)}`;
+    const uid = parseInt(req.query.uid as string, 10) || 0;
+
+    const token = generateToken(appId, appCertificate, channel, uid);
+
+    res.json({ token, channel, uid });
+  } catch (err: unknown) {
+    const message = err instanceof Error ? err.message : 'Unknown error';
+    res.status(500).json({ error: message });
+  }
+});
+
+export default router;

package/src/starters/web/server/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "outDir": "../dist/server",
+    "rootDir": ".",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "declaration": true
+  },
+  "include": ["./**/*.ts"]
+}

package/src/web/chat-client.html

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html><head><title>ConvoAI Headless</title></head>
 <body>
-<script src="https://download.agora.io/sdk/release/AgoraRTC_N-4.22.0.js"></script>
+<script src="/agora-sdk.js"></script>
 <script>
   const P = new URLSearchParams(location.search);
   const appId = P.get('appId');

package/src/web/client.html

@@ -42,7 +42,7 @@
     <p class="hint">Press Ctrl+C in the terminal to stop</p>
   </div>
 
-  <script src="https://download.agora.io/sdk/release/AgoraRTC_N-4.22.0.js"></script>
+  <script src="/agora-sdk.js"></script>
   <script>
     const P = new URLSearchParams(location.search);
     const appId = P.get('appId');

package/src/web/serve.ts

@@ -0,0 +1,45 @@
+/**
+ * Shared HTTP handler that serves HTML pages + the Agora RTC SDK from npm.
+ * Using the npm package (agora-rtc-sdk-ng) instead of CDN ensures each
+ * `npm install convoai` counts as an npm download for the SDK.
+ */
+import { readFileSync } from 'node:fs';
+import { createRequire } from 'node:module';
+import type { IncomingMessage, ServerResponse } from 'node:http';
+
+const require = createRequire(import.meta.url);
+
+let _sdkCache: Buffer | null = null;
+
+function getSdkContent(): Buffer {
+  if (!_sdkCache) {
+    // Resolve the package main entry (exports "." → AgoraRTC_N-production.js)
+    // Using the subpath directly would throw ERR_PACKAGE_PATH_NOT_EXPORTED
+    const sdkPath = require.resolve('agora-rtc-sdk-ng');
+    _sdkCache = readFileSync(sdkPath);
+  }
+  return _sdkCache;
+}
+
+/**
+ * Returns an HTTP request handler that serves:
+ *  - `/agora-sdk.js` → Agora RTC SDK from node_modules
+ *  - Everything else  → the provided HTML string
+ */
+export function createWebHandler(html: string): (req: IncomingMessage, res: ServerResponse) => void {
+  return (req, res) => {
+    const pathname = (req.url || '/').split('?')[0];
+    if (pathname === '/agora-sdk.js') {
+      const sdk = getSdkContent();
+      res.writeHead(200, {
+        'Content-Type': 'application/javascript; charset=utf-8',
+        'Content-Length': sdk.length,
+        'Cache-Control': 'public, max-age=86400',
+      });
+      res.end(sdk);
+    } else {
+      res.writeHead(200, { 'Content-Type': 'text/html; charset=utf-8' });
+      res.end(html);
+    }
+  };
+}