@guava-ai/guava-sdk 0.3.0 → 0.4.1

package/README.internal.md

@@ -0,0 +1,13 @@
+# (Guava Internal) Typescript SDK Instructions
+
+## Setup
+
+Run `npm install` to install dependencies.
+
+## Running Examples
+
+If you're modifying an example and want to run it, use the following.
+
+```bash
+npx tsx ./examples/scheduling-outbound.ts +1...
+```

package/README.md

@@ -1,19 +1,61 @@
 # Guava Typescript SDK
+![NPM Version](https://img.shields.io/npm/v/%40guava-ai%2Fguava-sdk)
 
-You will need two environment variables to use the SDK.
+This library allows you to build Guava voice agents using TypeScript or Javascript. Currently only NodeJS is officially supported as a runtime.
 
+## Documentation
+
+Full documentation for the TypeScript SDK can be found at [https://docs.goguava.ai/typescript-sdk/](https://docs.goguava.ai/typescript-sdk/)
+
+## Try an Example
+
+Export two environment variables. You should have received these in your beta invite email.
 ```bash
-export GUAVA_API_KEY="..."
-export GUAVA_AGENT_NUMBER="..."
+$ export GUAVA_API_KEY="..." # Your API key for authentication.
+$ export GUAVA_AGENT_NUMBER="..." # A phone number for your agent to use.
 ```
 
-Once those environment variables are set, you can run the examples.
-
+Run an outbound phone call example using `npx`. Replace the phone number with your own and your agent will call you.
 ```bash
-npx -- @guava-ai/guava-sdk property-insurance +15556667777
+$ npx @guava-ai/guava-sdk scheduling-outbound +15556667777 # Your agent will call this number.
 ```
 
-or e.g.
+## Installation
+
+Install the SDK using your preferred package manager.
+
 ```bash
-npx -- @guava-ai/guava-sdk thai-palace
+$ npm install @guava-ai/guava-sdk
+$ yarn add @guava-ai/guava-sdk
+$ pnpm add @guava-ai/guava-sdk
 ```
+
+The SDK can be used with Javascript, but TypeScript is highly recommended.
+
+## Basic Usage
+
+The Guava SDK is primarily used by subclassing `guava.CallController`. `CallController` subclasses implement callbacks that steer the call in real-time.
+
+You can make outbound calls using a `CallController` instance.
+
+```typescript
+import * as guava from "@guava-ai/guava-sdk";
+
+// Make an outbound call with a call controller.
+new guava.Client().createOutbound(
+    agentNumber, toNumber,
+    new MyCallController(),
+);
+```
+
+You can also accept inbound calls using Guava. You don't need to setup a server — inbound calls can be received on your dev machine, including behind NATs and most firewalls.
+Instead of passing a controller, you will pass a factory function that constructs a controller upon receipt of a call.
+
+```typescript
+// Attach a listener to the phone number.
+// Spawn new call controllers as calls come in.
+new guava.Client().listenInbound(
+    { agent_number: agentNumber },
+    () => new MyCallController(),
+);
+```

package/bin/example-runner.js

@@ -1,22 +1,31 @@
 #!/usr/bin/env node
 
+import { readdirSync } from "node:fs";
+import { fileURLToPath } from "node:url";
+
+const examplesURL = new URL("../dist/examples/", import.meta.url);
+const examplesDir = fileURLToPath(examplesURL);
+const availableExamples = readdirSync(examplesDir).filter(f => f.endsWith(".js")).map(f => f.replace(/\.js$/, ""));
+
 const exampleName = process.argv[2];
 if (!exampleName) {
   console.error("Usage: guava-example <example-name> <example-args>");
+  console.error("Available examples:", availableExamples.join(", "))
+  process.exit(1);
+}
+
+if (!availableExamples.includes(exampleName)) {
+  console.error(`Unknown example "${exampleName}". Available examples: ${availableExamples.join(", ")}`);
   process.exit(1);
 }
 
 const run = async () => {
   try {
     // ESM dynamic import works in both ESM packages and CJS CLI files in modern Node
-    const exampleModule = await import(new URL(`../dist/examples/${exampleName}.js`, import.meta.url));
-    exampleModule.run(process.argv.slice(3))
+    const exampleModule = await import(new URL(`${exampleName}.js`, examplesURL));
+    await exampleModule.run(process.argv.slice(3));
   } catch (err) {
-    if (err.code === "ERR_MODULE_NOT_FOUND") {
-      console.error(`Couldn't find example: ${exampleName}`)
-    } else {
-      console.error(err);
-    }
+    console.error(err);
     process.exit(1);
   }
 };

package/dist/examples/credit-card-activation.js

@@ -1,12 +1,3 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import { IntentRecognizer } from "../src/helpers/openai.js";
 import * as guava from "../src/index.js";
 const CUSTOMER_DB = [
@@ -19,13 +10,14 @@ const CUSTOMER_DB = [
     },
 ];
 function findCustomerBySSN(ssn) {
-    return CUSTOMER_DB.find((c) => c.ssn == ssn);
+    return CUSTOMER_DB.find((c) => c.ssn === ssn);
 }
 const ORGANIZATION_NAME = "Harper Valley Bank";
 class CreditCardActivationController extends guava.CallController {
+    choices = ["activate credit card", "anything else"];
+    intentRecognizer;
     constructor(logger) {
         super(logger);
-        this.choices = ["activate credit card", "anything else"];
         this.intentRecognizer = new IntentRecognizer(this.choices, logger);
         this.setPersona({
             organizationName: ORGANIZATION_NAME,
@@ -34,125 +26,115 @@ class CreditCardActivationController extends guava.CallController {
         this.readScript(`Hello, thank you for calling the credit card activation line for ${ORGANIZATION_NAME}. My name is Grace. Are you here to activate your credit card?`);
         this.acceptCall();
     }
-    onIntent(intent) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const choice = yield this.intentRecognizer.classify(intent);
-            this.logger.info(`Chosen intent: ${choice}`);
-            if (choice == "activate credit card") {
-                yield this.activateCreditCard();
-                return null;
+    async onIntent(intent) {
+        const choice = await this.intentRecognizer.classify(intent);
+        this.logger.info(`Chosen intent: ${choice}`);
+        if (choice === "activate credit card") {
+            await this.activateCreditCard();
+            return null;
+        }
+        else {
+            return "Unfortunately I'm not able to help with that.";
+        }
+    }
+    async findCustomer() {
+        let customer;
+        let cardNumber;
+        while (true) {
+            await this.awaitTask({
+                checklist: [
+                    guava.Field({
+                        description: "Could you give me your social security number?",
+                        key: "social_security_number",
+                        fieldType: "integer",
+                        required: true,
+                    }),
+                ],
+            });
+            const ssn_data = this.getField("social_security_number");
+            let ssn;
+            if (typeof ssn_data === "string") {
+                ssn = ssn_data;
             }
             else {
-                return "Unfortunately I'm not able to help with that.";
+                // Should we assume all payloads are strings? or leave room by returning unknown
+                ssn = JSON.stringify(ssn_data);
             }
-        });
-    }
-    findCustomer() {
-        return __awaiter(this, void 0, void 0, function* () {
-            let customer;
-            let cardNumber;
-            while (true) {
-                yield this.awaitTask({
-                    checklist: [
-                        {
-                            item_type: "field",
-                            description: "Could you give me your social security number?",
-                            key: "social_security_number",
-                            field_type: "integer",
-                            required: true,
-                        },
-                    ],
-                });
-                const ssn_data = this.getField("social_security_number");
-                let ssn;
-                if (typeof ssn_data == "string") {
-                    ssn = ssn_data;
-                }
-                else {
-                    // Should we assume all payloads are strings? or leave room by returning unknown
-                    ssn = JSON.stringify(ssn_data);
-                }
-                customer = findCustomerBySSN(ssn);
-                if (!customer) {
-                    this.sendInstruction("We were unable to identify the customer using the SSN they provided. Let the caller know this, and ask if they have the correct social security number.");
-                }
-                else {
-                    yield this.awaitTask({
-                        objective: "We were able to identify the customer using the Social Security Number they have provided. We're going to confirm the client's name.",
-                        checklist: [
-                            {
-                                item_type: "field",
-                                description: `We're going to confirm the client's name. Am I speaking with ${customer.name}?`,
-                                key: "is_client",
-                                field_type: "multiple_choice",
-                                choices: ["yes", "no"],
-                                required: true,
-                            },
-                        ],
-                    });
-                    if (this.getField("is_client") == "no") {
-                        this.sendInstruction("We were unable to identify the client's name in our files. Let the caller know this, and re-ask their social security number.");
-                    }
-                    else {
-                        break;
-                    }
-                }
+            customer = findCustomerBySSN(ssn);
+            if (!customer) {
+                this.sendInstruction("We were unable to identify the customer using the SSN they provided. Let the caller know this, and ask if they have the correct social security number.");
             }
-            this.sendInstruction("We were able to find the client's name in our files. Proceed to ask for their card number.");
-            while (true) {
-                yield this.awaitTask({
+            else {
+                await this.awaitTask({
+                    objective: "We were able to identify the customer using the Social Security Number they have provided. We're going to confirm the client's name.",
                     checklist: [
-                        {
-                            item_type: "field",
-                            field_type: "integer",
-                            description: "Could you read me the digits on the front of your credit card?",
-                            key: "credit_card_number",
+                        guava.Field({
+                            description: `We're going to confirm the client's name. Am I speaking with ${customer.name}?`,
+                            key: "is_client",
+                            fieldType: "multiple_choice",
+                            choices: ["yes", "no"],
                             required: true,
-                        },
+                        }),
                     ],
                 });
-                cardNumber = this.getField("credit_card_number");
-                if (!(cardNumber in customer.unactivated_cards)) {
-                    this.sendInstruction("We were unable to find the matching card number in our system. Let the caller know this, and re-ask for the credit card number.");
+                if (this.getField("is_client") === "no") {
+                    this.sendInstruction("We were unable to identify the client's name in our files. Let the caller know this, and re-ask their social security number.");
                 }
                 else {
-                    this.sendInstruction("We were able to find the matching card number in our system. Let the caller know this, and ask for security code on their card.");
                     break;
                 }
             }
-            const correctCvv = customer.unactivated_cards[cardNumber];
-            while (true) {
-                yield this.awaitTask({
-                    checklist: [
-                        {
-                            item_type: "field",
-                            field_type: "integer",
-                            key: "security_code",
-                            description: "To wrap up, could I get the security code on your card?",
-                            required: true,
-                        },
-                    ],
-                });
-                const security_code = this.getField("security_code");
-                if (security_code != correctCvv.toString()) {
-                    this.sendInstruction("We were unable to match the security code to the credit card. Let the caller know this and re-ask for the security code.");
-                }
-                else {
-                    break;
-                }
+        }
+        this.sendInstruction("We were able to find the client's name in our files. Proceed to ask for their card number.");
+        while (true) {
+            await this.awaitTask({
+                checklist: [
+                    guava.Field({
+                        fieldType: "integer",
+                        description: "Could you read me the digits on the front of your credit card?",
+                        key: "credit_card_number",
+                        required: true,
+                    }),
+                ],
+            });
+            cardNumber = this.getField("credit_card_number");
+            if (!(cardNumber in customer.unactivated_cards)) {
+                this.sendInstruction("We were unable to find the matching card number in our system. Let the caller know this, and re-ask for the credit card number.");
             }
-            this.hangup("Explain to the caller that their credit card has now been activated. Thank them for using the bank's services, and hang up.");
-        });
+            else {
+                this.sendInstruction("We were able to find the matching card number in our system. Let the caller know this, and ask for security code on their card.");
+                break;
+            }
+        }
+        const correctCvv = customer.unactivated_cards[cardNumber];
+        while (true) {
+            await this.awaitTask({
+                checklist: [
+                    guava.Field({
+                        fieldType: "integer",
+                        key: "security_code",
+                        description: "To wrap up, could I get the security code on your card?",
+                        required: true,
+                    }),
+                ],
+            });
+            const security_code = this.getField("security_code");
+            if (security_code !== correctCvv.toString()) {
+                this.sendInstruction("We were unable to match the security code to the credit card. Let the caller know this and re-ask for the security code.");
+            }
+            else {
+                break;
+            }
+        }
+        this.hangup("Explain to the caller that their credit card has now been activated. Thank them for using the bank's services, and hang up.");
     }
-    activateCreditCard() {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.sendInstruction("We are starting the credit card activation process, which starts with asking the caller for their social security number.");
-            yield this.findCustomer();
-        });
+    async activateCreditCard() {
+        this.sendInstruction("We are starting the credit card activation process, which starts with asking the caller for their social security number.");
+        await this.findCustomer();
     }
 }
 export function run(_args) {
-    const conn = new guava.Client().listenInbound({
+    new guava.Client().listenInbound({
         agent_number: process.env.GUAVA_AGENT_NUMBER,
     }, (logger) => new CreditCardActivationController(logger));
 }

package/dist/examples/credit-card-activation.js.map

@@ -1 +1 @@
-{"version":3,"file":"credit-card-activation.js","sourceRoot":"","sources":["../../examples/credit-card-activation.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,KAAK,MAAM,iBAAiB,CAAC;AASzC,MAAM,WAAW,GAAe;IAC9B;QACE,IAAI,EAAE,YAAY;QAClB,GAAG,EAAE,WAAW;QAChB,iBAAiB,EAAE;YACjB,kBAAkB,EAAE,GAAG;SACxB;KACF;CACF,CAAC;AAEF,SAAS,iBAAiB,CAAC,GAAW;IACpC,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC;AAC/C,CAAC;AAED,MAAM,iBAAiB,GAAG,oBAAoB,CAAC;AAE/C,MAAM,8BAA+B,SAAQ,KAAK,CAAC,cAAc;IAG/D,YAAY,MAAc;QACxB,KAAK,CAAC,MAAM,CAAC,CAAC;QAHR,YAAO,GAAG,CAAC,sBAAsB,EAAE,eAAe,CAAU,CAAC;QAInE,IAAI,CAAC,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACnE,IAAI,CAAC,UAAU,CAAC;YACd,gBAAgB,EAAE,iBAAiB;YACnC,YAAY,EAAE,uFAAuF,iBAAiB,GAAG;SAC1H,CAAC,CAAC;QACH,IAAI,CAAC,UAAU,CACb,oEAAoE,iBAAiB,gEAAgE,CACtJ,CAAC;QACF,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAEc,QAAQ,CAAC,MAAc;;YACpC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC5D,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,MAAM,EAAE,CAAC,CAAC;YAC7C,IAAI,MAAM,IAAI,sBAAsB,EAAE,CAAC;gBACrC,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBAChC,OAAO,IAAI,CAAC;YACd,CAAC;iBAAM,CAAC;gBACN,OAAO,+CAA+C,CAAC;YACzD,CAAC;QACH,CAAC;KAAA;IAEK,YAAY;;YAChB,IAAI,QAA8B,CAAC;YACnC,IAAI,UAAkB,CAAC;YACvB,OAAO,IAAI,EAAE,CAAC;gBACZ,MAAM,IAAI,CAAC,SAAS,CAAC;oBACnB,SAAS,EAAE;wBACT;4BACE,SAAS,EAAE,OAAO;4BAClB,WAAW,EAAE,gDAAgD;4BAC7D,GAAG,EAAE,wBAAwB;4BAC7B,UAAU,EAAE,SAAS;4BACrB,QAAQ,EAAE,IAAI;yBACf;qBACF;iBACF,CAAC,CAAC;gBAEH,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAC;gBACzD,IAAI,GAAW,CAAC;gBAChB,IAAI,OAAO,QAAQ,IAAI,QAAQ,EAAE,CAAC;oBAChC,GAAG,GAAG,QAAQ,CAAC;gBACjB,CAAC;qBAAM,CAAC;oBACN,gFAAgF;oBAChF,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;gBACjC,CAAC;gBACD,QAAQ,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;gBAClC,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACd,IAAI,CAAC,eAAe,CAClB,yJAAyJ,CAC1J,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,CAAC,SAAS,CAAC;wBACnB,SAAS,EACP,sIAAsI;wBACxI,SAAS,EAAE;4BACT;gCACE,SAAS,EAAE,OAAO;gCAClB,WAAW,EAAE,gEAAgE,QAAQ,CAAC,IAAI,GAAG;gCAC7F,GAAG,EAAE,WAAW;gCAChB,UAAU,EAAE,iBAAiB;gCAC7B,OAAO,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC;gCACtB,QAAQ,EAAE,IAAI;6BACf;yBACF;qBACF,CAAC,CAAC;oBAEH,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC;wBACvC,IAAI,CAAC,eAAe,CAClB,+HAA+H,CAChI,CAAC;oBACJ,CAAC;yBAAM,CAAC;wBACN,MAAM;oBACR,CAAC;gBACH,CAAC;YACH,CAAC;YAED,IAAI,CAAC,eAAe,CAClB,4FAA4F,CAC7F,CAAC;YACF,OAAO,IAAI,EAAE,CAAC;gBACZ,MAAM,IAAI,CAAC,SAAS,CAAC;oBACnB,SAAS,EAAE;wBACT;4BACE,SAAS,EAAE,OAAO;4BAClB,UAAU,EAAE,SAAS;4BACrB,WAAW,EACT,gEAAgE;4BAClE,GAAG,EAAE,oBAAoB;4BACzB,QAAQ,EAAE,IAAI;yBACf;qBACF;iBACF,CAAC,CAAC;gBAEH,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAAW,CAAC;gBAC3D,IAAI,CAAC,CAAC,UAAU,IAAI,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC;oBAChD,IAAI,CAAC,eAAe,CAClB,iIAAiI,CAClI,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,eAAe,CAClB,iIAAiI,CAClI,CAAC;oBACF,MAAM;gBACR,CAAC;YACH,CAAC;YAED,MAAM,UAAU,GAAG,QAAQ,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;YAC1D,OAAO,IAAI,EAAE,CAAC;gBACZ,MAAM,IAAI,CAAC,SAAS,CAAC;oBACnB,SAAS,EAAE;wBACT;4BACE,SAAS,EAAE,OAAO;4BAClB,UAAU,EAAE,SAAS;4BACrB,GAAG,EAAE,eAAe;4BACpB,WAAW,EACT,yDAAyD;4BAC3D,QAAQ,EAAE,IAAI;yBACf;qBACF;iBACF,CAAC,CAAC;gBAEH,MAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAW,CAAC;gBAC/D,IAAI,aAAa,IAAI,UAAU,CAAC,QAAQ,EAAE,EAAE,CAAC;oBAC3C,IAAI,CAAC,eAAe,CAClB,0HAA0H,CAC3H,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,MAAM;gBACR,CAAC;YACH,CAAC;YACD,IAAI,CAAC,MAAM,CACT,6HAA6H,CAC9H,CAAC;QACJ,CAAC;KAAA;IAEK,kBAAkB;;YACtB,IAAI,CAAC,eAAe,CAClB,2HAA2H,CAC5H,CAAC;YAEF,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC5B,CAAC;KAAA;CACF;AAED,MAAM,UAAU,GAAG,CAAC,KAAe;IACjC,MAAM,IAAI,GAAG,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC,aAAa,CAC3C;QACE,YAAY,EAAE,OAAO,CAAC,GAAG,CAAC,kBAAmB;KAC9C,EACD,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,8BAA8B,CAAC,MAAM,CAAC,CACvD,CAAC;AACJ,CAAC;AAED,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IACrB,GAAG,CAAC,EAAE,CAAC,CAAC;AACV,CAAC"}
+{"version":3,"file":"credit-card-activation.js","sourceRoot":"","sources":["../../examples/credit-card-activation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,KAAK,MAAM,iBAAiB,CAAC;AASzC,MAAM,WAAW,GAAe;IAC9B;QACE,IAAI,EAAE,YAAY;QAClB,GAAG,EAAE,WAAW;QAChB,iBAAiB,EAAE;YACjB,kBAAkB,EAAE,GAAG;SACxB;KACF;CACF,CAAC;AAEF,SAAS,iBAAiB,CAAC,GAAW;IACpC,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;AAChD,CAAC;AAED,MAAM,iBAAiB,GAAG,oBAAoB,CAAC;AAE/C,MAAM,8BAA+B,SAAQ,KAAK,CAAC,cAAc;IACvD,OAAO,GAAG,CAAC,sBAAsB,EAAE,eAAe,CAAU,CAAC;IAC7D,gBAAgB,CAAwC;IAChE,YAAY,MAAc;QACxB,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACnE,IAAI,CAAC,UAAU,CAAC;YACd,gBAAgB,EAAE,iBAAiB;YACnC,YAAY,EAAE,uFAAuF,iBAAiB,GAAG;SAC1H,CAAC,CAAC;QACH,IAAI,CAAC,UAAU,CACb,oEAAoE,iBAAiB,gEAAgE,CACtJ,CAAC;QACF,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAEQ,KAAK,CAAC,QAAQ,CAAC,MAAc;QACpC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC5D,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,MAAM,EAAE,CAAC,CAAC;QAC7C,IAAI,MAAM,KAAK,sBAAsB,EAAE,CAAC;YACtC,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAChC,OAAO,IAAI,CAAC;QACd,CAAC;aAAM,CAAC;YACN,OAAO,+CAA+C,CAAC;QACzD,CAAC;IACH,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,IAAI,QAA8B,CAAC;QACnC,IAAI,UAAkB,CAAC;QACvB,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,IAAI,CAAC,SAAS,CAAC;gBACnB,SAAS,EAAE;oBACT,KAAK,CAAC,KAAK,CAAC;wBACV,WAAW,EAAE,gDAAgD;wBAC7D,GAAG,EAAE,wBAAwB;wBAC7B,SAAS,EAAE,SAAS;wBACpB,QAAQ,EAAE,IAAI;qBACf,CAAC;iBACH;aACF,CAAC,CAAC;YAEH,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAC;YACzD,IAAI,GAAW,CAAC;YAChB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBACjC,GAAG,GAAG,QAAQ,CAAC;YACjB,CAAC;iBAAM,CAAC;gBACN,gFAAgF;gBAChF,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YACjC,CAAC;YACD,QAAQ,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;YAClC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,IAAI,CAAC,eAAe,CAClB,yJAAyJ,CAC1J,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,CAAC,SAAS,CAAC;oBACnB,SAAS,EACP,sIAAsI;oBACxI,SAAS,EAAE;wBACT,KAAK,CAAC,KAAK,CAAC;4BACV,WAAW,EAAE,gEAAgE,QAAQ,CAAC,IAAI,GAAG;4BAC7F,GAAG,EAAE,WAAW;4BAChB,SAAS,EAAE,iBAAiB;4BAC5B,OAAO,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC;4BACtB,QAAQ,EAAE,IAAI;yBACf,CAAC;qBACH;iBACF,CAAC,CAAC;gBAEH,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE,CAAC;oBACxC,IAAI,CAAC,eAAe,CAClB,+HAA+H,CAChI,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,eAAe,CAClB,4FAA4F,CAC7F,CAAC;QACF,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,IAAI,CAAC,SAAS,CAAC;gBACnB,SAAS,EAAE;oBACT,KAAK,CAAC,KAAK,CAAC;wBACV,SAAS,EAAE,SAAS;wBACpB,WAAW,EAAE,gEAAgE;wBAC7E,GAAG,EAAE,oBAAoB;wBACzB,QAAQ,EAAE,IAAI;qBACf,CAAC;iBACH;aACF,CAAC,CAAC;YAEH,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAAW,CAAC;YAC3D,IAAI,CAAC,CAAC,UAAU,IAAI,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC;gBAChD,IAAI,CAAC,eAAe,CAClB,iIAAiI,CAClI,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,eAAe,CAClB,iIAAiI,CAClI,CAAC;gBACF,MAAM;YACR,CAAC;QACH,CAAC;QAED,MAAM,UAAU,GAAG,QAAQ,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAC1D,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,IAAI,CAAC,SAAS,CAAC;gBACnB,SAAS,EAAE;oBACT,KAAK,CAAC,KAAK,CAAC;wBACV,SAAS,EAAE,SAAS;wBACpB,GAAG,EAAE,eAAe;wBACpB,WAAW,EAAE,yDAAyD;wBACtE,QAAQ,EAAE,IAAI;qBACf,CAAC;iBACH;aACF,CAAC,CAAC;YAEH,MAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAW,CAAC;YAC/D,IAAI,aAAa,KAAK,UAAU,CAAC,QAAQ,EAAE,EAAE,CAAC;gBAC5C,IAAI,CAAC,eAAe,CAClB,0HAA0H,CAC3H,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,MAAM;YACR,CAAC;QACH,CAAC;QACD,IAAI,CAAC,MAAM,CACT,6HAA6H,CAC9H,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,kBAAkB;QACtB,IAAI,CAAC,eAAe,CAClB,2HAA2H,CAC5H,CAAC;QAEF,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;IAC5B,CAAC;CACF;AAED,MAAM,UAAU,GAAG,CAAC,KAAe;IACjC,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC,aAAa,CAC9B;QACE,YAAY,EAAE,OAAO,CAAC,GAAG,CAAC,kBAAmB;KAC9C,EACD,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,8BAA8B,CAAC,MAAM,CAAC,CACvD,CAAC;AACJ,CAAC;AAED,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IACrB,GAAG,CAAC,EAAE,CAAC,CAAC;AACV,CAAC"}

package/dist/examples/property-insurance.js

@@ -1,35 +1,21 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import * as guava from "../src/index.js";
 import { DocumentQA } from "../src/helpers/openai.js";
 import { PROPERTY_INSURANCE_POLICY } from "../src/example_data.js";
 class InsuranceCallController extends guava.CallController {
-    constructor(logger) {
-        super(logger);
-        this.documentQA = new DocumentQA("harper-valley-property-insurance", PROPERTY_INSURANCE_POLICY, logger);
-    }
-    onCallStart() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.setPersona({
-                organizationName: "Harper Valley Property Insurance",
-            });
-            this.setTask({
-                objective: "You are making an outbound call to a potential customer. Your task is to answer questions regarding property insurance policy until there are no more questions.",
-            });
+    documentQA;
+    constructor() {
+        super();
+        this.documentQA = new DocumentQA("harper-valley-property-insurance", PROPERTY_INSURANCE_POLICY);
+        this.setPersona({
+            organizationName: "Harper Valley Property Insurance",
         });
-    }
-    onQuestion(question) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.documentQA.ask(question);
+        this.setTask({
+            objective: "You are making an outbound call to a potential customer. Your task is to answer questions regarding property insurance policy until there are no more questions.",
         });
     }
+    async onQuestion(question) {
+        return await this.documentQA.ask(question);
+    }
 }
 export function run(args) {
     const [phone] = args;
@@ -37,7 +23,7 @@ export function run(args) {
         console.error("Usage: guava-example property-insurance <phone>");
         process.exit(1);
     }
-    new guava.Client().createOutbound(process.env.GUAVA_AGENT_NUMBER, phone, (logger) => new InsuranceCallController(logger));
+    new guava.Client().createOutbound(process.env.GUAVA_AGENT_NUMBER, phone, new InsuranceCallController());
 }
 if (import.meta.main) {
     run(process.argv.slice(2));

package/dist/examples/property-insurance.js.map

@@ -1 +1 @@
-{"version":3,"file":"property-insurance.js","sourceRoot":"","sources":["../../examples/property-insurance.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,KAAK,KAAK,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAItD,OAAO,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAEnE,MAAM,uBAAwB,SAAQ,KAAK,CAAC,cAAc;IAExD,YAAY,MAAc;QACxB,KAAK,CAAC,MAAM,CAAC,CAAC;QAEd,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAC9B,kCAAkC,EAClC,yBAAyB,EACzB,MAAM,CACP,CAAC;IACJ,CAAC;IAEc,WAAW;;YACxB,MAAM,IAAI,CAAC,UAAU,CAAC;gBACpB,gBAAgB,EAAE,kCAAkC;aACrD,CAAC,CAAC;YACH,IAAI,CAAC,OAAO,CAAC;gBACX,SAAS,EACP,kKAAkK;aACrK,CAAC,CAAC;QACL,CAAC;KAAA;IAEc,UAAU,CAAC,QAAgB;;YACxC,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC7C,CAAC;KAAA;CACF;AAED,MAAM,UAAU,GAAG,CAAC,IAAc;IAChC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IAErB,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACjE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC,cAAc,CAC/B,OAAO,CAAC,GAAG,CAAC,kBAAmB,EAC/B,KAAK,EACL,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,uBAAuB,CAAC,MAAM,CAAC,CAChD,CAAC;AACJ,CAAC;AAED,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IACrB,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AAC7B,CAAC"}
+{"version":3,"file":"property-insurance.js","sourceRoot":"","sources":["../../examples/property-insurance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAEnE,MAAM,uBAAwB,SAAQ,KAAK,CAAC,cAAc;IAChD,UAAU,CAAa;IAC/B;QACE,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,kCAAkC,EAAE,yBAAyB,CAAC,CAAC;QAEhG,IAAI,CAAC,UAAU,CAAC;YACd,gBAAgB,EAAE,kCAAkC;SACrD,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,CAAC;YACX,SAAS,EACP,kKAAkK;SACrK,CAAC,CAAC;IACL,CAAC;IAEQ,KAAK,CAAC,UAAU,CAAC,QAAgB;QACxC,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC7C,CAAC;CACF;AAED,MAAM,UAAU,GAAG,CAAC,IAAc;IAChC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IAErB,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACjE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC,cAAc,CAC/B,OAAO,CAAC,GAAG,CAAC,kBAAmB,EAC/B,KAAK,EACL,IAAI,uBAAuB,EAAE,CAC9B,CAAC;AACJ,CAAC;AAED,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IACrB,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AAC7B,CAAC"}

package/dist/examples/scheduling-outbound.d.ts

@@ -0,0 +1 @@
+export declare function run(args: string[]): void;

package/dist/examples/scheduling-outbound.js

@@ -0,0 +1,77 @@
+import * as guava from "../src/index.js";
+import { DatetimeFilter } from "../src/helpers/openai.js";
+import { mockAppointmentsForFuture } from "../src/example_data.js";
+class SchedulingController extends guava.CallController {
+    patientName;
+    datetimeFilter;
+    constructor(patientName) {
+        super();
+        this.patientName = patientName;
+        // This is a basic appointment time selector that pulls from a mock list of appointments.
+        // In production, you would likely replace this with your own agentic scheduling backend.
+        this.datetimeFilter = new DatetimeFilter({
+            sourceList: mockAppointmentsForFuture(),
+        });
+        // Use setPersona to set basic information about the agent, as well as it's high-level purpose.
+        this.setPersona({
+            organizationName: "Bright Smile Dental",
+            agentName: "Grace",
+            agentPurpose: `You are calling ${patientName} to help them schedule a dental appointment`,
+        });
+        // reachPerson is a convenience function to confirm that we are talking to the intended recipient.
+        this.reachPerson(this.patientName, {
+            onSuccess: () => this.scheduleRecipient(),
+            onFailure: () => this.recipientUnavailable(),
+        });
+    }
+    scheduleRecipient() {
+        // In the branch where we reached the intended participant,
+        // set a task to collect the desired appointment time.
+        this.setTask({
+            // The check list is an ordered list of items for the agent to go through.
+            checklist: [
+                // guava.Say instructions are verbatim.
+                guava.Say("Let me look to see what appointment times we have available."),
+                // We have one field to collect, which is the appointment_time.
+                guava.Field({
+                    key: "appointment_time",
+                    fieldType: "calendar_slot",
+                    description: "Find a time that works for the caller",
+                    // This field has a choice generator attached. The agent will invoke this function
+                    // with a natural language query, allowing the caller to select between the different options.
+                    // The agent can potentially invoke the callback multiple times if the caller rejects the options
+                    // or provides a new query.
+                    choiceGenerator: async (query) => {
+                        // Use the simple DatetimeFilter class we instantiated earlier.
+                        const result = await this.datetimeFilter.filter(query, { maxResults: 3 });
+                        this.logger.info("Choice generator results: %s", JSON.stringify(result));
+                        return result;
+                    },
+                }),
+                guava.Say("Your appointment has been confirmed! Have a nice day."),
+            ],
+        }, () => this.hangup("Thank them for their time and hang up the call."));
+    }
+    recipientUnavailable() {
+        this.hangup("Apologize for your mistake and hang up the call.");
+    }
+    onSessionDone() {
+        // This callback is invoked at the end of the bot session.
+        const selectedTime = this.getField("appointment_time");
+        if (selectedTime) {
+            this.logger.info(`Appointment confirmed for: ${selectedTime}`);
+        }
+    }
+}
+export function run(args) {
+    const [toNumber, patientName = "Benjamin Buttons"] = args;
+    if (!toNumber) {
+        console.error("Usage: guava-example scheduling-outbound <phone> [name]");
+        process.exit(1);
+    }
+    new guava.Client().createOutbound(process.env.GUAVA_AGENT_NUMBER, toNumber, new SchedulingController(patientName));
+}
+if (import.meta.main) {
+    run(process.argv.slice(2));
+}
+//# sourceMappingURL=scheduling-outbound.js.map

package/dist/examples/scheduling-outbound.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduling-outbound.js","sourceRoot":"","sources":["../../examples/scheduling-outbound.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAEnE,MAAM,oBAAqB,SAAQ,KAAK,CAAC,cAAc;IACpC,WAAW,CAAS;IACpB,cAAc,CAAiB;IAEhD,YAAY,WAAmB;QAC7B,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAE/B,yFAAyF;QACzF,yFAAyF;QACzF,IAAI,CAAC,cAAc,GAAG,IAAI,cAAc,CAAC;YACvC,UAAU,EAAE,yBAAyB,EAAE;SACxC,CAAC,CAAC;QAEH,+FAA+F;QAC/F,IAAI,CAAC,UAAU,CAAC;YACd,gBAAgB,EAAE,qBAAqB;YACvC,SAAS,EAAE,OAAO;YAClB,YAAY,EAAE,mBAAmB,WAAW,6CAA6C;SAC1F,CAAC,CAAC;QAEH,kGAAkG;QAClG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE;YACjC,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzC,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE;SAC7C,CAAC,CAAC;IACL,CAAC;IAEO,iBAAiB;QACvB,2DAA2D;QAC3D,sDAAsD;QACtD,IAAI,CAAC,OAAO,CACV;YACE,0EAA0E;YAC1E,SAAS,EAAE;gBACT,uCAAuC;gBACvC,KAAK,CAAC,GAAG,CAAC,8DAA8D,CAAC;gBACzE,+DAA+D;gBAC/D,KAAK,CAAC,KAAK,CAAC;oBACV,GAAG,EAAE,kBAAkB;oBACvB,SAAS,EAAE,eAAe;oBAC1B,WAAW,EAAE,uCAAuC;oBAEpD,kFAAkF;oBAClF,8FAA8F;oBAC9F,iGAAiG;oBACjG,2BAA2B;oBAC3B,eAAe,EAAE,KAAK,EAAE,KAAa,EAAE,EAAE;wBACvC,+DAA+D;wBAC/D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC;wBAC1E,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,8BAA8B,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;wBACzE,OAAO,MAAM,CAAC;oBAChB,CAAC;iBACF,CAAC;gBACF,KAAK,CAAC,GAAG,CAAC,uDAAuD,CAAC;aACnE;SACF,EACD,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,iDAAiD,CAAC,CACrE,CAAC;IACJ,CAAC;IAEO,oBAAoB;QAC1B,IAAI,CAAC,MAAM,CAAC,kDAAkD,CAAC,CAAC;IAClE,CAAC;IAEQ,aAAa;QACpB,0DAA0D;QAC1D,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC;QACvD,IAAI,YAAY,EAAE,CAAC;YACjB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,8BAA8B,YAAY,EAAE,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;CACF;AAED,MAAM,UAAU,GAAG,CAAC,IAAc;IAChC,MAAM,CAAC,QAAQ,EAAE,WAAW,GAAG,kBAAkB,CAAC,GAAG,IAAI,CAAC;IAE1D,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,CAAC,KAAK,CAAC,yDAAyD,CAAC,CAAC;QACzE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC,cAAc,CAC/B,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAC9B,QAAQ,EACR,IAAI,oBAAoB,CAAC,WAAW,CAAC,CACtC,CAAC;AACJ,CAAC;AAED,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IACrB,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AAC7B,CAAC"}