@guava-ai/guava-sdk 0.2.0 → 0.4.0

package/dist/src/action_item.d.ts

@@ -1,34 +1,47 @@
 import * as z from "zod";
-export declare const fieldItemType: z.ZodUnion<z.ZodLiteral<"text" | "integer" | "date" | "datetime" | "multiple_choice">[]>;
-export type FieldItemType = z.input<typeof fieldItemType>;
-export declare const fieldItem: z.ZodObject<{
+export declare const FieldItemType: z.ZodUnion<z.ZodLiteral<"text" | "integer" | "date" | "datetime" | "multiple_choice" | "calendar_slot">[]>;
+export type FieldItemType = z.input<typeof FieldItemType>;
+export type ChoiceGenerator = (query: string) => Promise<[string[], string[]]>;
+export declare const FieldItem: z.ZodObject<{
     item_type: z.ZodLiteral<"field">;
     key: z.ZodString;
     description: z.ZodString;
-    field_type: z.ZodUnion<z.ZodLiteral<"text" | "integer" | "date" | "datetime" | "multiple_choice">[]>;
+    field_type: z.ZodUnion<z.ZodLiteral<"text" | "integer" | "date" | "datetime" | "multiple_choice" | "calendar_slot">[]>;
     required: z.ZodDefault<z.ZodBoolean>;
     choices: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    choiceGenerator: z.ZodOptional<z.ZodCustom<ChoiceGenerator, ChoiceGenerator>>;
 }, z.core.$strip>;
-export type Field = z.input<typeof fieldItem>;
-export declare const sayItem: z.ZodObject<{
+export type FieldItem = z.input<typeof FieldItem>;
+export declare const SerializableFieldItem: z.ZodObject<{
+    item_type: z.ZodLiteral<"field">;
+    key: z.ZodString;
+    description: z.ZodString;
+    field_type: z.ZodUnion<z.ZodLiteral<"text" | "integer" | "date" | "datetime" | "multiple_choice" | "calendar_slot">[]>;
+    required: z.ZodDefault<z.ZodBoolean>;
+    choices: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    is_search_field: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+export type SerializableFieldItem = z.input<typeof SerializableFieldItem>;
+export declare const SayItem: z.ZodObject<{
     item_type: z.ZodLiteral<"say">;
     statement: z.ZodString;
     key: z.ZodDefault<z.ZodString>;
 }, z.core.$strip>;
-export type Say = z.input<typeof sayItem>;
-export declare const todoItem: z.ZodObject<{
+export type SayItem = z.input<typeof SayItem>;
+export declare const TodoItem: z.ZodObject<{
     item_type: z.ZodLiteral<"todo">;
     description: z.ZodString;
     key: z.ZodDefault<z.ZodString>;
 }, z.core.$strip>;
-export type Todo = z.input<typeof todoItem>;
-export declare const actionItem: z.ZodUnion<readonly [z.ZodObject<{
+export type TodoItem = z.input<typeof TodoItem>;
+export declare const ActionItem: z.ZodUnion<readonly [z.ZodObject<{
     item_type: z.ZodLiteral<"field">;
     key: z.ZodString;
     description: z.ZodString;
-    field_type: z.ZodUnion<z.ZodLiteral<"text" | "integer" | "date" | "datetime" | "multiple_choice">[]>;
+    field_type: z.ZodUnion<z.ZodLiteral<"text" | "integer" | "date" | "datetime" | "multiple_choice" | "calendar_slot">[]>;
     required: z.ZodDefault<z.ZodBoolean>;
     choices: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    is_search_field: z.ZodDefault<z.ZodBoolean>;
 }, z.core.$strip>, z.ZodObject<{
     item_type: z.ZodLiteral<"say">;
     statement: z.ZodString;
@@ -38,4 +51,13 @@ export declare const actionItem: z.ZodUnion<readonly [z.ZodObject<{
     description: z.ZodString;
     key: z.ZodDefault<z.ZodString>;
 }, z.core.$strip>]>;
-export type ActionItem = z.input<typeof actionItem>;
+export type ActionItem = z.input<typeof ActionItem>;
+export declare function Field(options: {
+    key: string;
+    description: string;
+    fieldType: FieldItemType;
+    required?: boolean;
+    choices?: string[];
+    choiceGenerator?: ChoiceGenerator;
+}): FieldItem;
+export declare function Say(statement: string): SayItem;

package/dist/src/action_item.js

@@ -1,29 +1,56 @@
 import * as z from "zod";
-export const fieldItemType = z.union(["text", "date", "datetime", "integer", "multiple_choice"].map((val) => z.literal(val)));
-export const fieldItem = z
+export const FieldItemType = z.union(["text", "date", "datetime", "integer", "multiple_choice", "calendar_slot"].map((val) => z.literal(val)));
+export const FieldItem = z
     .object({
     item_type: z.literal("field"),
     key: z.string(),
     description: z.string(),
-    field_type: fieldItemType,
+    field_type: FieldItemType,
     required: z.boolean().default(true),
     choices: z.array(z.string()).default([]),
+    choiceGenerator: z.custom((val) => typeof val === "function").optional(),
 })
     .refine((field) => {
-    if (field.field_type == "multiple_choice" && field.choices.length > 10) {
+    if (field.field_type === "multiple_choice" && field.choices.length > 10) {
         process.emitWarning("Performance degrades with large number of choices for multiple choice field.", "ACTION_ITEM");
     }
     return true;
 });
-export const sayItem = z.object({
+export const SerializableFieldItem = z.object({
+    item_type: z.literal("field"),
+    key: z.string(),
+    description: z.string(),
+    field_type: FieldItemType,
+    required: z.boolean().default(true),
+    choices: z.array(z.string()).default([]),
+    is_search_field: z.boolean().default(false),
+});
+export const SayItem = z.object({
     item_type: z.literal("say"),
     statement: z.string(),
     key: z.string().default(() => Math.random().toString(16).substring(2, 6)),
 });
-export const todoItem = z.object({
+export const TodoItem = z.object({
     item_type: z.literal("todo"),
     description: z.string(),
     key: z.string().default(() => Math.random().toString(16).substring(2, 6)),
 });
-export const actionItem = z.union([fieldItem, sayItem, todoItem]);
+export const ActionItem = z.union([SerializableFieldItem, SayItem, TodoItem]);
+export function Field(options) {
+    return FieldItem.parse({
+        item_type: "field",
+        key: options.key,
+        description: options.description,
+        field_type: options.fieldType,
+        required: options.required,
+        choices: options.choices,
+        choiceGenerator: options.choiceGenerator,
+    });
+}
+export function Say(statement) {
+    return SayItem.parse({
+        item_type: "say",
+        statement: statement,
+    });
+}
 //# sourceMappingURL=action_item.js.map

package/dist/src/action_item.js.map

@@ -1 +1 @@
-{"version":3,"file":"action_item.js","sourceRoot":"","sources":["../../src/action_item.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CACjC,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,iBAAiB,CAAW,CAAC,GAAG,CACvE,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CACxB,CACF,CAAC;AAGF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC;KACvB,MAAM,CAAC;IACN,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IAC7B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,UAAU,EAAE,aAAa;IACzB,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;IACnC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;CACzC,CAAC;KACD,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;IAChB,IAAI,KAAK,CAAC,UAAU,IAAI,iBAAiB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QACvE,OAAO,CAAC,WAAW,CACjB,8EAA8E,EAC9E,aAAa,CACd,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC,CAAC;AAGL,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9B,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IAC3B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAC1E,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/B,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;IAC5B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAC1E,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC"}
+{"version":3,"file":"action_item.js","sourceRoot":"","sources":["../../src/action_item.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CACjC,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,iBAAiB,EAAE,eAAe,CAAW,CAAC,GAAG,CACxF,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CACxB,CACF,CAAC;AAKF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC;KACvB,MAAM,CAAC;IACN,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IAC7B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,UAAU,EAAE,aAAa;IACzB,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;IACnC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IACxC,eAAe,EAAE,CAAC,CAAC,MAAM,CAAkB,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,UAAU,CAAC,CAAC,QAAQ,EAAE;CAC1F,CAAC;KACD,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;IAChB,IAAI,KAAK,CAAC,UAAU,KAAK,iBAAiB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QACxE,OAAO,CAAC,WAAW,CACjB,8EAA8E,EAC9E,aAAa,CACd,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC,CAAC;AAGL,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IAC7B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,UAAU,EAAE,aAAa;IACzB,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;IACnC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IACxC,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;CAC5C,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9B,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IAC3B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAC1E,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/B,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;IAC5B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAC1E,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,qBAAqB,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;AAG9E,MAAM,UAAU,KAAK,CAAC,OAOrB;IACC,OAAO,SAAS,CAAC,KAAK,CAAC;QACrB,SAAS,EAAE,OAAO;QAClB,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,SAAS;QAC7B,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,eAAe,EAAE,OAAO,CAAC,eAAe;KACzC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,SAAiB;IACnC,OAAO,OAAO,CAAC,KAAK,CAAC;QACnB,SAAS,EAAE,KAAK;QAChB,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;AACL,CAAC"}

package/dist/src/call-controller.d.ts

@@ -0,0 +1,137 @@
+import { type Logger } from "./logging.ts";
+import { type Command } from "./commands.ts";
+import type { GuavaEvent, CallerSpeechEvent, AgentSpeechEvent } from "./events.ts";
+import { type FieldItem, type SayItem } from "./action_item.ts";
+export type TaskObjective = {
+    objective: string;
+} | {
+    objective?: string;
+    checklist: (FieldItem | SayItem | string)[];
+};
+export type ReachPersonOutcome = {
+    key: string;
+    onOutcome: () => void;
+    description?: string;
+    nextActionPreview?: string;
+};
+type ReachPersonOptions = {
+    onSuccess: () => void;
+    onFailure: () => void;
+    greeting?: string;
+} | {
+    outcomes: ReachPersonOutcome[];
+    greeting?: string;
+};
+/**
+ * Interface between Guava services and user-supplied code
+ */
+export declare class CallController {
+    private _commandQueue;
+    private _on_complete_current_task?;
+    private _current_task_id?;
+    /**
+     * @protected
+     * @description logger used to emit diagnostics
+     */
+    protected logger: Logger;
+    private _drain?;
+    private _fieldValues;
+    private _searchFunctionsByKey;
+    constructor(logger?: Logger);
+    /**
+     * @description Supply a function used to consume commands from the internal command queue.
+     *
+     * The function is expected to remove from the argument array commands that it has handled (iterating
+     * through the result of `Array.splice(0)` is sufficient)
+     */
+    setDrain(newDrain: (_: Command[]) => Promise<void>): void;
+    /**
+     * @description [inbound] receive a call, and process further.
+     */
+    protected acceptCall(): Promise<void>;
+    /**
+     * @description read a span of text verbatim
+     */
+    protected readScript(script: string): Promise<void>;
+    /**
+     * @description [inbound] reject a call
+     */
+    protected rejectCall(): Promise<void>;
+    protected addInfo(_info: string): Promise<void>;
+    /**
+     * @description read a span of text non-verbatim
+     */
+    protected sendInstruction(instruction: string): Promise<void>;
+    /**
+     * @description provide identifiers the agent will use to identify the virtual agent
+     */
+    protected setPersona(args: {
+        organizationName?: string;
+        agentName?: string;
+        agentPurpose?: string;
+        voice?: string;
+    }): Promise<void>;
+    /**
+     * @description direct the agent to collect information
+     * @param goal {} an objective string and/or a checklist of information to collect
+     * @param on_complete {} a callback to call once the information is available from the agent
+     * @param args {} arguments to pass through to the `on_complete` callback
+     */
+    protected setTask(goal: TaskObjective, on_complete?: (...c: any[]) => void, ...args: any[]): void;
+    /**
+     * @description direct the agent to collect information, continuing execution once the agent has collected the information
+     * @param goal {} an objective string and/or a checklist of information to collect
+     */
+    protected awaitTask(goal: TaskObjective): Promise<void>;
+    /**
+     * @description retrieve a piece of information that the agent has collected
+     * @param key {string} key of the field checklist item
+     */
+    protected getField(key: string): unknown;
+    /**
+     * @description [inbound] hang up an accepted call
+     */
+    protected hangup(final_instructions?: string): Promise<void>;
+    /**
+     * @description helper for reaching a specific contact on an outbound call and recording their availability.
+     */
+    protected reachPerson(contactFullName: string, options: ReachPersonOptions): void;
+    /**
+     * @description transfer an accepted call
+     */
+    protected transfer(to_number: string, transfer_message?: string): void;
+    private sendCommand;
+    private flush;
+    onEvent(event: GuavaEvent): Promise<void>;
+    /**
+     * @description called when an inbound call is received. The overriding function must start
+     * with `await super.onIncomingCall(from_number)`
+     */
+    onIncomingCall(from_number?: string): Promise<void>;
+    /**
+     * @description called when a call is connected by the API, whether inbound or outbound
+     */
+    onCallStart(): Promise<void>;
+    /**
+     * @description called when the caller speaks to the agent.
+     */
+    onCallerSpeech(event: CallerSpeechEvent): Promise<void>;
+    /**
+     * @description called when the agent speaks to the caller.
+     */
+    onAgentSpeech(event: AgentSpeechEvent): Promise<void>;
+    /**
+     * @description called when the caller expresses a task they wish to execute
+     */
+    onIntent(intent: string): Promise<string | null>;
+    /**
+     * @description called when the agent needs to respond to a question that it doesn't know
+     * the answer to.
+     */
+    onQuestion(question: string): Promise<string>;
+    /**
+     * @description called when the bot session has ended.
+     */
+    onSessionDone(): void;
+}
+export {};