Documentation

import { createWidget } from "@gamaro.io/widget";

// container accepts a CSS selector OR an HTMLElement
const widget = createWidget({
  apiKey: "pk_your_key",
  container: "#chat-container",
});

<!-- B2B qualification widget -->
<script
  src="https://unpkg.com/@gamaro.io/widget@latest/dist/widget.umd.js"
  data-api-key="pk_your_b2b_key"
></script>

<!-- Real estate widget (same page) -->
<script
  src="https://unpkg.com/@gamaro.io/widget@latest/dist/widget.umd.js"
  data-api-key="pk_your_immo_key"
></script>

import { createWidget } from "@gamaro.io/widget";

// Each API key maps to an Agent with its own vertical, theme, and
// position — all configured from the admin portal.
const b2bWidget = createWidget({ apiKey: "pk_your_b2b_key" });
const immoWidget = createWidget({
  apiKey: "pk_your_immo_key",
  // container pins the widget to a specific DOM node (inline mode).
  container: document.getElementById("demo-immo"),
});

// Access instances after they're ready
b2bWidget.on("ready", () => {
  // window.GamaroApps.get(b2bWidget.applicationId) → GamaroAPI
  console.log("B2B widget ready:", b2bWidget.applicationId);
});

interface CoverageZone {
  readonly label: string;
  readonly departmentCodes: readonly string[];
  readonly countryCode?: string;
}

interface DataSource {
  readonly id: string;
  readonly configKey?: string;
  readonly displayName: string;
  readonly coverageDescription: string;
  readonly coverage?: CoverageZone;

  getCapabilities(): ReadonlySet<DataSourceCapability>;

  search?(params: Record<string, unknown>): Promise<unknown[]>;
  getStats?(zone: string): Promise<Record<string, unknown>>;
  getAreaMetrics?(zone: string, filters: Record<string, unknown>): Promise<Record<string, unknown>>;
  estimate?(params: Record<string, unknown>): Promise<Record<string, unknown>>;
  count?(areas: string[], filters: Record<string, unknown>): Promise<number>;
  checkCoverage?(zone: string, coverage?: CoverageZone): Promise<{ covered: boolean; message?: string }>;
  listTopCitiesByInventory?(limit: number): Promise<
    Array<{ city: string; count: number; minPrice: number; maxPrice: number }>
  >;
}

class MyApiDataSource implements DataSource {
  readonly id = "my-api";
  readonly displayName = "Mon API Produits";
  readonly coverageDescription = "Catalogue produit via API REST";

  getCapabilities() {
    return new Set(["search", "count"]);
  }

  async search(params) {
    const res = await fetch(`https://api.example.com/products?${qs(params)}`);
    return res.json();
  }

  async count(areas, filters) {
    const res = await fetch("https://api.example.com/products/count", {
      method: "POST",
      body: JSON.stringify({ areas, filters }),
    });
    const data = await res.json();
    return data.count;
  }
}

// Subscribe to events
window.Gamaro.on("ready", () => {
  console.log("Agent is ready");
});

window.Gamaro.on("profile-update", () => {
  console.log("Profile was updated"); // signal only, no data
});

window.Gamaro.on("qualified", () => {
  console.log("Lead qualified"); // signal only, no data
  // Lead details: see the Leads page of the Gamaro portal
});

window.Gamaro.on("identity-verified", (data) => {
  console.log("Identity verified:", data.email);
});

window.Gamaro.on("quota-warning", (data) => {
  console.warn("Quota low:", data.remaining, "/", data.limit);
});

window.Gamaro.on("error", (data) => {
  console.error("Error:", data.code, data.message);
});