Masheev React Sdk

Masheev React SDK

Build fully custom chat UIs using React hooks. Two approaches:

1. @masheev/embed-sdk/react — Widget in an iframe, controlled via hooks
2. @masheev/embed-sdk/headless — No iframe, direct WebSocket connection, full UI control

When to Use Which

Widget Hook (/react)

import { useMasheev } from "@masheev/embed-sdk/react";

function App() {
  const {
    open, close, toggle,
    hide, show,
    sendMessage,
    setInputValue,
    updateContext,
    updateContact,
    updateTools,
    updateWorkflow,
    setQuestions,
    setListening,
    resetConversation,
    on, off,
    containerRef,     // For embedded mode — attach to a DOM element
    isReady,
  } = useMasheev({
    inboxId: "YOUR_INBOX_ID",
    mode: "chat-widget",
    user: { name: "Jane", email: "jane@example.com" },
  });

  return (
    <div>
      <button disabled={!isReady}>Open Chat</button>
    </div>
  );
}

Singleton pattern: Multiple useMasheev() calls with the same inboxId share a single SDK instance and iframe. The iframe is destroyed only when the last consumer unmounts.

Headless Mode (/headless)

import {
  MasheevProvider,
  useWidgetSession,
  useWidgetChat,
  useWidgetSocket,
  useReadAloud,
} from "@masheev/embed-sdk/headless";

function App() {
  return (
    <MasheevProvider config={{
      inboxId: "YOUR_INBOX_ID",
      apiBase: "https://api.masheev.com",
      customerInfo: { name: "Jane", email: "jane@example.com" },
    }}>
      <CustomChat />
    </MasheevProvider>
  );
}

function CustomChat() {
  const { conversationId, greeting, workflowRunState } = useWidgetSession();
  const { messages, sendMessage, isStreaming } = useWidgetChat();
  const { status: connectionStatus } = useWidgetSocket();

  return (
    <div>
      <div className="messages">
        {messages.map((msg) => (
          <div key={msg.id} className={msg.role}>
            {msg.content}
          </div>
        ))}
        {isStreaming && <div className="typing">AI is typing...</div>}
      </div>
      <input
        => {
          if (e.key === "Enter") {
            sendMessage(e.currentTarget.value);
            e.currentTarget.value = "";
          }
        }}
      />
    </div>
  );
}

Provider Config

interface MasheevProviderConfig {
  inboxId: string;                          // Required
  apiBase?: string;                         // Default: "https://api.masheev.com"
  turnstileSiteKey?: string;                // Cloudflare Turnstile (anti-bot)
  customerInfo?: {
    name?: string;
    email?: string;
    phone?: string;
  };
  tools?: readonly ClientToolDefinition[];  // Client-side tools
  instructions?: string;                    // Tool usage instructions for AI
  workflow?: WorkflowConfig;                // Conversational workflow
  onStepComplete?: (payload: WorkflowStepCompletePayload) => void;
  onWorkflowComplete?: (payload: WorkflowCompletePayload) => void;
}

Headless Hooks Reference

Defining Tools with Zod

import { clientTool } from "@masheev/embed-sdk/headless";
import { z } from "zod";

const bookingTool = clientTool({
  name: "check_availability",
  description: "Check appointment availability for a given date",
  parameters: z.object({
    date: z.string().describe("ISO date string"),
    service: z.string().describe("Service type"),
  }),
  execute: async (args, { onProgress }) => {
    onProgress("Checking calendar...");
    const slots = await fetchSlots(args.date, args.service);
    return { success: true, data: { slots } };
  },
});

// Pass to provider
<MasheevProvider config={{ inboxId: "...", tools: [bookingTool] }}>

Workflow Helpers

import { defineWorkflow, validateWorkflowConfig } from "@masheev/embed-sdk/headless";

const
  id: "user_onboarding",
  name: "New User Onboarding",
  steps: [
    { id: "greeting", name: "Welcome", instructions: "Greet the user by name: {{context.name}}" },
    { id: "collect_info", name: "Collect Details", tools: ["check_availability"] },
    { id: "confirm", name: "Confirm Booking", instructions: "Summarize and confirm" },
  ],
  context: { name: "Jane" },
});

// Validate before passing to provider
const result = validateWorkflowConfig(onboardingFlow);
if (!result.valid) console.error(result.errors);

See references/headless.md for advanced patterns (custom message components, streaming, reconnection).