@rannah-labs/react-voice-orb 1.1.3

package/dist/src/app/Types/defaults.d.ts

@@ -0,0 +1,7 @@
+import { z } from "zod";
+import type { ToolField, VGAgentTool } from "./firebase";
+export declare const systemVariablesKeys: z.ZodEnum<["phone_number", "timestamp", "channel"]>;
+export declare const defaultSystemVariables: ToolField[];
+export declare const defaultSystemToolsKeys: z.ZodEnum<["Forward-Call"]>;
+export declare const defaultSystemTools: VGAgentTool[];
+export declare const uiEnginePrompt: string;

package/dist/src/app/Types/defaults.js

@@ -0,0 +1,210 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uiEnginePrompt = exports.defaultSystemTools = exports.defaultSystemToolsKeys = exports.defaultSystemVariables = exports.systemVariablesKeys = void 0;
+const zod_1 = require("zod");
+exports.systemVariablesKeys = zod_1.z.enum([
+    "phone_number",
+    "timestamp",
+    "channel",
+]);
+//
+exports.defaultSystemVariables = [
+    {
+        id: "phone_number",
+        type: "string",
+        required: true,
+        key: "phone_number",
+        in: "input",
+        isEnv: true,
+        description: "The phone number of the caller.",
+        isSystem: true,
+    },
+    {
+        id: "channel",
+        type: "string",
+        required: true,
+        key: "channel",
+        in: "input",
+        isEnv: true,
+        description: "The channel of the current conversation, web-chat, voice, whatsapp, etc..",
+        isSystem: true,
+    },
+    {
+        id: "timestamp",
+        type: "string",
+        required: true,
+        key: "timestamp",
+        in: "input",
+        isEnv: true,
+        description: "The timestamp of the current conversation in ISO 8601 format.",
+        isSystem: true,
+    },
+];
+exports.defaultSystemToolsKeys = zod_1.z.enum(["Forward-Call"]);
+exports.defaultSystemTools = [
+    {
+        id: "Forward-Call",
+        name: "Forward-Call",
+        description: "Forward a call to the given phone number and only works on phone channels (Twilio)",
+        variablesIds: ["phone_number"],
+    },
+    {
+        id: "human_handoff",
+        name: "human_handoff",
+        description: "Hand off the call to a human agent",
+        variablesIds: [],
+    },
+];
+exports.uiEnginePrompt = `FINALLY YOU MUST OUTPUT A VALID JSON ARRAY OF MESSAGES ONLY AND YOU  MUST FOLLOW THE INSTRUCITONS MENTIONED AHEAD!!!
+
+--- START UI ENGINE PROMPT --- 
+## Instructions on How to Create Dynamic UI Elements Based on Context
+
+### Guidelines:
+1. **Output Requirements**:
+    - Output must be a JSON array of objects.
+    - The output **must** adhere strictly to the TypeScript schema provided.
+    - Start the JSON array with "[" and end with "]".
+
+2. **General Rules**:
+    - **Do not** include  Output only JSON eliding any pre-text, post-text or explanations. Extraneous output will cause error.
+    - **URLs used within the JSON output must exclusively derive from the KB search tool.** If a required URL is absent from the KB, mention its unavailability explicitly.
+    - **Preferred Structure**:
+        - Start with a text message to initiate the conversation.
+        - Follow with a card or collection of cards to showcase visuals or important points with potential call-to-action buttons. This visually anchors the conversation.
+        - Include an iframe or image message, especially if you have a video URL from the search tool, to enhance engagement.
+        - End with buttons or a choice message to guide the user's next steps based on the context retrieved from the KB search tool.
+    - When using links for images in cards/image messages, always ensure they start with "https://" and end with a valid image extension like ".png/.jpg/.jpeg/.webp/.gif/etc.."
+             
+THE FOLLOWING IS THE TYPESCRIPT SCHEMA:
+--- START TYPESCRIPT SCHEMA ---
+/**
+* Interface for a text payload.
+* Use when sending a simple text message.
+* @interface
+*/
+interface TextPayload {
+ message?: string; // Message content, supports Markdown
+}
+
+/**
+* General interface for a Button Object
+* @interface
+*/
+interface ButtonModel {
+ name: string; // Label of the button
+ request: {
+     type: "open_url"; // Request type for sending text or opening a URL
+     payload: {
+url: string; // URL to open when the button is clicked (ONLY USE URLs from the KB SEARCH TOOL NEVER MAKE UP URLs IF WHAT YOU NEED IS NOT IN THE KB SEARCH TOOL THEN DO NOT USE THIS.)
+     };
+ } | {
+     type: "text"; // Request type for sending text or opening a URL
+     payload: {
+message: string; // Variable message to send when the button is clicked
+     };
+ };
+}
+
+/**
+* Interface for a choice payload.
+* Use when you want to share a url or predict/recommend what the user may say next.
+* @interface
+*/
+interface ChoicePayload {
+ buttons: ButtonModel[];
+}
+
+${false
+    ? ""
+    : `/**
+* Interface for a visual message.
+* Use when you have an image url to present (.png/.jpg/.jpeg/.webp/.gif/etc..) 
+* @interface
+*/
+interface VisualPayload {
+ image: string; // URL of the image
+}`}
+
+/**
+* Interface for a card payload.
+* Use when you want to present an image with a caption or with action buttons.
+* @interface
+*/
+interface CardPayload {
+ imageUrl?: string; // (Optional) URL of the image MUST END WITH .png/.jpg/.jpeg/.webp/.gif/etc..
+ title: string; // (Required) Title of the card (supports markdown)
+ description?: {
+     text: string; // Description of the card (supports markdown)
+ };
+ buttons?: ButtonModel[]; // (Optional) Array of buttons for the card
+}
+
+/**
+* Interface for a carousel payload containing an array of cards.
+* Use whenever you have multiple cards to present.
+* @interface
+*/
+interface CarouselPayload {
+ cards: CardPayload[]; // Array of card messages
+}
+
+${false
+    ? ""
+    : `/**
+* Interface for an iframe payload containing a valid iframe html.
+* Use whenever you have an iframe SPECIALLY YOUTUBE/VIMEO OR POPULAR VIDEO HOSTING PLATFORMS.
+* HIGH PRIO TO USE THIS IF YOU CAN GET THE URL OF A VIDEO FROM THE SEARCH TOOL, YOU WILL FIND "YOUTUBE VIDEO" in the KB result as a hint.
+* @interface
+*/
+interface iFramePayload {
+ layout: "vertical" | "horizontal"; // whether the iframe should be adjusted to be vertical or horizontal (vertical is for videos/youtube, horizontal is for anything else)
+ url: string; // URL of the iframe OR the iframe html (If its a video iframe like youtube only the URL is needed, if its a custom iframe then the whole iframe html is needed)
+}`}
+
+// all the messages types
+// you can use any of these types according to the message you should send
+type MessageType = "text" | "choice" ${false ? "" : `| "visual"`} | "cardV2" | "carousel" | ${false ? "" : `| "iFrame"`};
+
+// message interface
+interface Message {
+ type: MessageType; // Type of the message
+ payload: TextPayload | ChoicePayload ${false ? "" : `| ImagePayload `} | CardPayload | CarouselPayload  ${false ? "" : `| iFramePayload`}; // Payload of the message
+}
+
+/**
+* Final response interface
+* This should be your FINAL output: AN ARRAY OF Message OBJECTS
+* @type
+*/
+type FinalResponse = Message[] // ARRAY OF MESSAGE OBJECTS AS A JSON STRING.
+--- END TYPESCRIPT SCHEMA ---
+
+### Example JSON Structures:
+#### Example 1:
+[{
+ "type": "text",
+ "payload": {
+     "message": "Hello there! How can I help you today?"
+ }
+}]
+ 
+#### Example 2:
+[{
+ "type": "text",
+ "payload": {
+    "message": "Sure! Here's a showcase of our services in brief details:"
+ }
+},
+{
+ "type": "carousel",
+ "payload": {
+    "cards": [
+        {
+        "title": "Service 1",
+            "description": {
+                "text": "Service 1 is a great service that helps you with your needs."
+            }
+        }
+]  
+--- END UI ENGINE PROMPT ---`;

package/dist/src/app/Types/demo_extension.d.ts

@@ -0,0 +1,11 @@
+export declare const VFSelectExtension: {
+    name: string;
+    type: string;
+    match: ({ trace }: {
+        trace: any;
+    }) => boolean;
+    render: ({ trace, element }: {
+        trace: any;
+        element: any;
+    }) => void;
+};

package/dist/src/app/Types/demo_extension.js

@@ -0,0 +1,190 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VFSelectExtension = void 0;
+const uiDefault = {
+    primaryButtonColor: '#2e7ff1',
+    primaryButtonColorHover: '#0c74e4',
+    primaryButtonTextLabel: 'Confirm',
+    primaryButtonTextColor: '#ffffff',
+    destructiveButtonColor: '#db1b42',
+    destructiveButtonColorHover: '#cd0038',
+    destructiveButtonTextLabel: 'Cancel',
+    destructiveButtonTextColor: '#ffffff',
+    defaultOptionText: 'Select option',
+};
+const validateData = (data) => {
+    if (!Array.isArray(data)) {
+        throw new Error('Invalid data: must be an array');
+    }
+    if (!data.length) {
+        throw new Error('Invalid data: must have values');
+    }
+    data.forEach((item) => {
+        if (typeof item !== 'string') {
+            if (!Object.hasOwn(item, 'text') || !Object.hasOwn(item, 'value')) {
+                throw new Error('Invalid data: items must be either strings or objects with text and value keys');
+            }
+        }
+    });
+};
+const process = (trace) => {
+    let { data = [], ui = {} } = trace.payload;
+    // throws error if data is invalid
+    validateData(data);
+    // merge ui options objects
+    ui = Object.assign({}, uiDefault, ui);
+    return { data, ui };
+};
+const createSelectElement = (data, ui) => {
+    let selectedOption = null;
+    const selectElement = document.createElement('select');
+    selectElement.id = 'selectInput';
+    selectElement.required = true;
+    // create default option
+    const optionDefault = document.createElement('option');
+    optionDefault.text = ui.defaultOptionText;
+    optionDefault.value = '';
+    selectElement.appendChild(optionDefault);
+    // create data options
+    data.forEach((item) => {
+        const optionElement = document.createElement('option');
+        if (typeof item === 'string' || item instanceof String) {
+            optionElement.text = item;
+            optionElement.value = item;
+        }
+        else {
+            optionElement.text = item.text;
+            optionElement.value = item.value;
+            if (item.selected) {
+                optionElement.selected = true;
+                selectedOption = item.value;
+            }
+        }
+        selectElement.appendChild(optionElement);
+    });
+    return { selectElement, selectedOption };
+};
+const createFormContainer = (ui) => {
+    const formContainer = document.createElement('div');
+    formContainer.innerHTML = `
+      <style>
+        #container {
+          display: flex;
+          flex-direction: column;
+          justify-content: flex-start;
+          margin: 0;
+          padding: 0;
+          width: 225px;
+          max-width: none;
+          overflow: visible;
+          overflowX: hidden;
+          overflowY: hidden;
+        }
+        #selectInput {
+          padding: 5px;
+          border-radius: 8px;
+          border-color: #ddd;
+          font-size: 15px;
+        }
+        #buttonContainer {
+          display: flex;
+          gap: 10px;
+          margin-top: 10px;
+          transition: opacity 0.3s ease;
+        }
+        #submitButton, #cancelButton {
+          font-size: 15px;
+          font-weight: 600;
+          border: none;
+          padding: 10px;
+          border-radius: 8px;
+          cursor: pointer;
+        }
+        #submitButton {
+          flex: 1;
+          color: ${ui.primaryButtonTextColor};
+          background: ${ui.primaryButtonColor};
+        }
+        #submitButton:hover:not(:disabled) {
+          background: ${ui.primaryButtonColorHover};
+        }
+        #cancelButton {
+          flex: 1;
+          color: ${ui.destructiveButtonTextColor};
+          background: ${ui.destructiveButtonColor};
+        }
+        #cancelButton:hover:not(:disabled) {
+          background: ${ui.destructiveButtonColorHover};
+        }
+        #submitButton:disabled, #cancelButton:disabled {
+          background: #ccc;
+          cursor: not-allowed;
+          color: #666;
+        }
+      </style>
+      <form id="form">
+        <div id="container"></div>
+        <div id="buttonContainer">
+          <button id="submitButton" type="submit">${ui.primaryButtonTextLabel}</button>
+          <button id="cancelButton" type="button">${ui.destructiveButtonTextLabel}</button>
+        </div>
+      </form>`;
+    return formContainer;
+};
+exports.VFSelectExtension = {
+    name: 'Select',
+    type: 'response',
+    match: ({ trace }) => trace.type === 'ext_select_input' ||
+        trace.payload.name === 'ext_select_input',
+    render: ({ trace, element }) => {
+        try {
+            const { data, ui } = process(trace);
+            // form container
+            const formContainer = createFormContainer(ui);
+            // select container
+            const selectContainer = formContainer.querySelector('#container');
+            // select element
+            let { selectElement, selectedOption } = createSelectElement(data, ui);
+            selectElement.addEventListener('change', (event) => {
+                selectedOption = event.target.value;
+            });
+            selectContainer.appendChild(selectElement);
+            // submit button
+            const submitButton = formContainer.querySelector('#submitButton');
+            // cancel button
+            const cancelButton = formContainer.querySelector('#cancelButton');
+            cancelButton.addEventListener('click', () => {
+                // push cancel event to voiceflow runtime
+                window.voiceflow.chat.interact({
+                    type: 'cancel',
+                });
+                selectElement.disabled = true;
+                submitButton.disabled = true;
+                cancelButton.disabled = true;
+            });
+            // form
+            const form = formContainer.querySelector('#form');
+            form.addEventListener('submit', (event) => {
+                event.preventDefault();
+                // push complete event to voiceflow runtime
+                window.voiceflow.chat.interact({
+                    type: 'complete',
+                    payload: { value: selectedOption },
+                });
+                selectElement.disabled = true;
+                submitButton.disabled = true;
+                cancelButton.disabled = true;
+            });
+            // add form container to voiceflow element
+            element.appendChild(formContainer);
+        }
+        catch (error) {
+            console.log('VFSelectExtension', error);
+            // push error event to voiceflow runtime
+            window.voiceflow.chat.interact({
+                type: 'error',
+                payload: { message: error.message ?? 'Unknown error' },
+            });
+        }
+    },
+};

package/dist/src/app/Types/envObject.d.ts

@@ -0,0 +1,97 @@
+export declare const envObject: {
+    NODE_ENV: string;
+    VERCEL: string;
+    VERCEL_ENV: string;
+    VERCEL_URL: string;
+    VERCEL_GIT_PROVIDER: string;
+    VERCEL_GIT_PREVIOUS_SHA: string;
+    VERCEL_GIT_REPO_SLUG: string;
+    VERCEL_GIT_REPO_OWNER: string;
+    VERCEL_GIT_REPO_ID: string;
+    VERCEL_GIT_COMMIT_REF: string;
+    VERCEL_GIT_COMMIT_SHA: string;
+    VERCEL_GIT_COMMIT_MESSAGE: string;
+    VERCEL_GIT_COMMIT_AUTHOR_LOGIN: string;
+    VERCEL_GIT_COMMIT_AUTHOR_NAME: string;
+    VERCEL_GIT_PULL_REQUEST_ID: string;
+    KV_URL: string;
+    KV_REST_API_URL: string;
+    KV_REST_API_TOKEN: string;
+    KV_REST_API_READ_ONLY_TOKEN: string;
+    EDGE_CONFIG: string;
+    BLOB_READ_WRITE_TOKEN: string;
+    RESEND_API_KEY: string;
+    DEEPGRAM_API_KEY: string;
+    QDRANT_API_KEY: string;
+    OPENAI_API_KEY: string;
+    GOOGLE_GENAI_API_KEY: string;
+    ANTHROPIC_API_KEY: string;
+    GROQ_API_KEY: string;
+    OAI_US_ENDPOINT: string;
+    OAI_US_API_KEY: string;
+    STRIPE_SECRET_KEY_TEST: string;
+    STRIPE_SECRET_KEY: string;
+    NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY_TEST: string;
+    NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY: string;
+    R2_ACCESS_KEY_ID: string;
+    R2_SECRET_ACCESS_KEY: string;
+    R2_BUCKET_NAME: string;
+    R2_ENDPOINT: string;
+    R2_PUBLIC_ENDPOINT: string;
+    SUPABASE_SUPER_KEY: string;
+    SUPABASE_URL: string;
+    META_CLIENT_ID: string;
+    META_CLIENT_SECRET: string;
+    VG_SERVER_KEY: string;
+    HUGGING_FACE_API_KEY: string;
+    INHOUSE_API_KEY: string;
+    USESCRAPER_API_KEY: string;
+    VG_APP_SECRET: string;
+    PROJECT_ID_VERCEL: string;
+    TEAM_ID_VERCEL: string;
+    AUTH_BEARER_TOKEN: string;
+    GOOGLE_API_KEY: string;
+    NEXT_PUBLIC_ROOT_DOMAIN: string;
+    ZOHO_REFRESH_TOKEN: string;
+    ZOHO_CLIENT_ID: string;
+    ZOHO_CLIENT_SECRET: string;
+    QDRANT_KEY: string;
+    VF_KB_KEY: string;
+    MAILSENDER_KEY: string;
+    GOOGLE_FONTS_API_KEY: string;
+    PAYPAL_CLIENT_KEY: string;
+    PAYPAL_SECRET_KEY: string;
+    PAYPAL_CLIENT_KEY_LIVE: string;
+    PAYPAL_SECRET_KEY_LIVE: string;
+    MISTRAL_API_KEY: string;
+    SENDGRID_API_KEY: string;
+    SYNTHFLOW_API_KEY: string;
+    LLAMA_INDEX_API_KEY: string;
+    GOOGLE_AI_API_KEY: string;
+    CALENDLY_PERSONAL_ACCESS_TOKEN: string;
+    CAL_API_KEY: string;
+    NEXT_PUBLIC_MY_PASSWORD: string;
+    POSTGRES_EU_PASSWORD: string;
+    POSTGRES_NA_PASSWORD: string;
+    PORT: string;
+    BUNNY_CDN_PASSWORD: string;
+    BUNNY_CDN_USERNAME: string;
+    PLAYHT_USER_ID: string;
+    PLAYHT_API_KEY: string;
+    CARTESIA_API_KEY: string;
+    GLADIA_API_KEY: string;
+    ELEVENLABS_API_KEY: string;
+    ASSEMBLY_API_KEY: string;
+    TWILIO_ACCOUNT_SID: string;
+    TWILIO_AUTH_TOKEN: string;
+    RIMEAI_API_KEY: string;
+    AZURE_API_KEY: string;
+    AZURE_REGION: string;
+    DIGITAL_OCEAN_PERSONAL_TOKEN: string;
+    SPEECHMATICS_API_KEY: string;
+    DEEPSEEK_API_KEY: string;
+    NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY_LIVE: string;
+    NEXT_PUBLIC_STRIPE_PRICING_TABLE_ID_LIVE: string;
+    PARTNER_STACK_KEY: string;
+    SMARTPROXY_API_KEY: string;
+};

package/dist/src/app/Types/envObject.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.envObject = void 0;
+const config_1 = require("../../../vg-docker/src/+global_consts/config");
+exports.envObject = config_1.GLOBAL_ONPREM.secrets.ENV;