@useago/sdk 0.3.2 → 0.3.4

package/dist/functions-CWSRi3xv.js

@@ -0,0 +1,312 @@
+import { n as s } from "./rolldown-runtime-DxmricAu.js";
+var S = /* @__PURE__ */ s({
+  copyToClipboard: () => p,
+  getLocalStorage: () => f,
+  getUserLocation: () => m,
+  highlightElement: () => g,
+  openUrl: () => l,
+  scrollToElement: () => h,
+  setLocalStorage: () => y,
+  setTheme: () => d,
+  showConfirmDialog: () => u,
+  showNotification: () => c,
+  showToast: () => a,
+  submitForm: () => v,
+  trackEvent: () => b
+}), a = {
+  name: "showToast",
+  description: "Show a toast notification to the user. Use this to confirm actions or display brief messages.",
+  parameters: {
+    type: "object",
+    properties: {
+      message: {
+        type: "string",
+        description: "The message to display"
+      },
+      type: {
+        type: "string",
+        description: "Toast type",
+        enum: [
+          "success",
+          "error",
+          "warning",
+          "info"
+        ]
+      },
+      duration: {
+        type: "number",
+        description: "Duration in milliseconds (default 3000)"
+      }
+    },
+    required: ["message"]
+  },
+  handler: async () => ({
+    shown: !1,
+    error: "No toast handler configured"
+  })
+}, c = {
+  name: "showNotification",
+  description: "Show a browser notification to the user. Useful for important alerts even when the tab is not focused.",
+  parameters: {
+    type: "object",
+    properties: {
+      title: {
+        type: "string",
+        description: "Notification title"
+      },
+      body: {
+        type: "string",
+        description: "Notification body text"
+      }
+    },
+    required: ["title"]
+  },
+  handler: async (e) => typeof Notification > "u" ? {
+    shown: !1,
+    error: "Notifications not supported"
+  } : Notification.permission === "denied" ? {
+    shown: !1,
+    error: "Notification permission denied"
+  } : (Notification.permission !== "granted" && await Notification.requestPermission(), Notification.permission === "granted" ? (new Notification(e.title, { body: e.body }), { shown: !0 }) : {
+    shown: !1,
+    error: "Permission not granted"
+  })
+}, l = {
+  name: "openUrl",
+  description: "Open a URL in a new browser tab.",
+  parameters: {
+    type: "object",
+    properties: { url: {
+      type: "string",
+      description: "The URL to open"
+    } },
+    required: ["url"]
+  },
+  handler: async (e) => (window.open(e.url, "_blank", "noopener,noreferrer"), { opened: !0 })
+}, p = {
+  name: "copyToClipboard",
+  description: "Copy text to the user's clipboard.",
+  parameters: {
+    type: "object",
+    properties: { text: {
+      type: "string",
+      description: "The text to copy"
+    } },
+    required: ["text"]
+  },
+  handler: async (e) => (await navigator.clipboard.writeText(e.text), { copied: !0 })
+}, d = {
+  name: "setTheme",
+  description: "Change the application's color theme. Sets a data-theme attribute on the document element.",
+  parameters: {
+    type: "object",
+    properties: { theme: {
+      type: "string",
+      description: "Theme to apply",
+      enum: [
+        "light",
+        "dark",
+        "system"
+      ]
+    } },
+    required: ["theme"]
+  },
+  handler: async (e) => {
+    const t = e.theme;
+    return document.documentElement.setAttribute("data-theme", t), t === "dark" ? document.documentElement.classList.add("dark") : document.documentElement.classList.remove("dark"), {
+      theme: t,
+      applied: !0
+    };
+  }
+}, u = {
+  name: "showConfirmDialog",
+  description: "Show a confirmation dialog to the user and return their choice (true/false).",
+  parameters: {
+    type: "object",
+    properties: { message: {
+      type: "string",
+      description: "The confirmation message to display"
+    } },
+    required: ["message"]
+  },
+  handler: async (e) => ({ confirmed: window.confirm(e.message) })
+}, m = {
+  name: "getUserLocation",
+  description: "Get the user's current geographic location (requires permission).",
+  parameters: {
+    type: "object",
+    properties: {}
+  },
+  handler: async () => navigator.geolocation ? new Promise((e) => {
+    navigator.geolocation.getCurrentPosition((t) => e({
+      latitude: t.coords.latitude,
+      longitude: t.coords.longitude,
+      accuracy: t.coords.accuracy
+    }), (t) => e({ error: t.message }));
+  }) : { error: "Geolocation not supported" }
+}, h = {
+  name: "scrollToElement",
+  description: "Scroll the page to a specific element identified by CSS selector.",
+  parameters: {
+    type: "object",
+    properties: {
+      selector: {
+        type: "string",
+        description: "CSS selector of the element to scroll to (e.g. '#section-pricing')"
+      },
+      behavior: {
+        type: "string",
+        description: "Scroll behavior",
+        enum: ["smooth", "instant"]
+      }
+    },
+    required: ["selector"]
+  },
+  handler: async (e) => {
+    const t = document.querySelector(e.selector);
+    return t ? (t.scrollIntoView({ behavior: e.behavior || "smooth" }), { scrolled: !0 }) : {
+      scrolled: !1,
+      error: `Element not found: ${e.selector}`
+    };
+  }
+}, y = {
+  name: "setLocalStorage",
+  description: "Store a value in the browser's localStorage.",
+  parameters: {
+    type: "object",
+    properties: {
+      key: {
+        type: "string",
+        description: "Storage key"
+      },
+      value: {
+        type: "string",
+        description: "Value to store"
+      }
+    },
+    required: ["key", "value"]
+  },
+  handler: async (e) => (localStorage.setItem(e.key, e.value), { stored: !0 })
+}, f = {
+  name: "getLocalStorage",
+  description: "Retrieve a value from the browser's localStorage.",
+  parameters: {
+    type: "object",
+    properties: { key: {
+      type: "string",
+      description: "Storage key"
+    } },
+    required: ["key"]
+  },
+  handler: async (e) => {
+    const t = localStorage.getItem(e.key);
+    return {
+      key: e.key,
+      value: t,
+      found: t !== null
+    };
+  }
+}, g = {
+  name: "highlightElement",
+  description: "Highlight a DOM element to draw the user's attention (e.g. for onboarding).",
+  parameters: {
+    type: "object",
+    properties: {
+      selector: {
+        type: "string",
+        description: "CSS selector of the element to highlight"
+      },
+      color: {
+        type: "string",
+        description: "Highlight border color (default: #3b82f6)"
+      }
+    },
+    required: ["selector"]
+  },
+  handler: async (e) => {
+    const t = document.querySelector(e.selector);
+    if (!t) return {
+      highlighted: !1,
+      error: `Element not found: ${e.selector}`
+    };
+    const r = t.style.outline, o = e.color || "#3b82f6";
+    return t.style.outline = `3px solid ${o}`, t.style.outlineOffset = "2px", t.scrollIntoView({
+      behavior: "smooth",
+      block: "center"
+    }), setTimeout(() => {
+      t.style.outline = r, t.style.outlineOffset = "";
+    }, 3e3), { highlighted: !0 };
+  }
+}, v = {
+  name: "submitForm",
+  description: "Fill and submit an HTML form on the page. Pass field values as key-value pairs.",
+  parameters: {
+    type: "object",
+    properties: {
+      selector: {
+        type: "string",
+        description: "CSS selector of the form element"
+      },
+      values: {
+        type: "string",
+        description: "JSON string of field name → value pairs"
+      }
+    },
+    required: ["selector"]
+  },
+  handler: async (e) => {
+    const t = document.querySelector(e.selector);
+    if (!t) return {
+      submitted: !1,
+      error: `Form not found: ${e.selector}`
+    };
+    if (e.values) {
+      const r = JSON.parse(e.values);
+      for (const [o, n] of Object.entries(r)) {
+        const i = t.elements.namedItem(o);
+        i && (i.value = n);
+      }
+    }
+    return t.requestSubmit(), { submitted: !0 };
+  }
+}, b = {
+  name: "trackEvent",
+  description: "Track a custom analytics event. Override the handler to wire up your analytics provider.",
+  parameters: {
+    type: "object",
+    properties: {
+      event: {
+        type: "string",
+        description: "Event name"
+      },
+      properties: {
+        type: "string",
+        description: "JSON string of event properties"
+      }
+    },
+    required: ["event"]
+  },
+  handler: async (e) => {
+    const t = e.properties ? JSON.parse(e.properties) : {};
+    return console.log(`[AGO Analytics] ${e.event}`, t), {
+      tracked: !0,
+      event: e.event
+    };
+  }
+};
+export {
+  g as a,
+  y as c,
+  c as d,
+  a as f,
+  m as i,
+  d as l,
+  b as m,
+  S as n,
+  l as o,
+  v as p,
+  f as r,
+  h as s,
+  p as t,
+  u
+};

package/dist/helpers.cjs

@@ -1,15 +1 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_functions = require("./functions--c6lx3ic.cjs");
-exports.copyToClipboard = require_functions.copyToClipboard;
-exports.getLocalStorage = require_functions.getLocalStorage;
-exports.getUserLocation = require_functions.getUserLocation;
-exports.highlightElement = require_functions.highlightElement;
-exports.openUrl = require_functions.openUrl;
-exports.scrollToElement = require_functions.scrollToElement;
-exports.setLocalStorage = require_functions.setLocalStorage;
-exports.setTheme = require_functions.setTheme;
-exports.showConfirmDialog = require_functions.showConfirmDialog;
-exports.showNotification = require_functions.showNotification;
-exports.showToast = require_functions.showToast;
-exports.submitForm = require_functions.submitForm;
-exports.trackEvent = require_functions.trackEvent;
+Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const o=require("./functions-BH1X5kas.cjs");exports.copyToClipboard=o.copyToClipboard;exports.getLocalStorage=o.getLocalStorage;exports.getUserLocation=o.getUserLocation;exports.highlightElement=o.highlightElement;exports.openUrl=o.openUrl;exports.scrollToElement=o.scrollToElement;exports.setLocalStorage=o.setLocalStorage;exports.setTheme=o.setTheme;exports.showConfirmDialog=o.showConfirmDialog;exports.showNotification=o.showNotification;exports.showToast=o.showToast;exports.submitForm=o.submitForm;exports.trackEvent=o.trackEvent;

package/dist/{helpers/functions.d.ts → helpers.d.cts}

@@ -1,62 +1,121 @@
-import type { ClientFunctionDefinition } from "../functions/types";
-/**
- * Show a toast/notification to the user.
- * The handler is a no-op by default — wire it up to your toast library.
- *
- * ```ts
- * import { showToast } from "@useago/sdk/helpers";
- * showToast.handler = async (args) => { myToast(args.message); return { shown: true }; };
- * client.registerFunction(showToast);
- * ```
- */
-export declare const showToast: ClientFunctionDefinition;
-/**
- * Show a browser notification (requires permission).
- */
-export declare const showNotification: ClientFunctionDefinition;
-/**
- * Open a URL in a new tab.
- */
-export declare const openUrl: ClientFunctionDefinition;
-/**
- * Copy text to clipboard.
- */
-export declare const copyToClipboard: ClientFunctionDefinition;
-/**
- * Set the application theme (light/dark/system).
- * Default handler toggles a `data-theme` attribute on `<html>`.
- */
-export declare const setTheme: ClientFunctionDefinition;
-/**
- * Show a confirm dialog and return the user's choice.
- */
-export declare const showConfirmDialog: ClientFunctionDefinition;
-/**
- * Get the user's geolocation.
- */
-export declare const getUserLocation: ClientFunctionDefinition;
-/**
- * Scroll to an element on the page.
- */
-export declare const scrollToElement: ClientFunctionDefinition;
-/**
- * Set a value in localStorage.
- */
-export declare const setLocalStorage: ClientFunctionDefinition;
-/**
- * Get a value from localStorage.
- */
-export declare const getLocalStorage: ClientFunctionDefinition;
-/**
- * Highlight an element on the page (useful for guided tours).
- */
-export declare const highlightElement: ClientFunctionDefinition;
-/**
- * Submit a form on the page programmatically.
- */
-export declare const submitForm: ClientFunctionDefinition;
-/**
- * Track a custom analytics event.
- * Default handler logs to console — replace with your analytics provider.
- */
-export declare const trackEvent: ClientFunctionDefinition;
+/**
+ * Single-object function definition — combines name, schema, and handler.
+ *
+ * ```ts
+ * const fn = defineFunction({
+ *   name: "lookupOrder",
+ *   description: "Look up an order by ID",
+ *   parameters: { type: "object", properties: { id: { type: "string" } }, required: ["id"] },
+ *   handler: async (args) => fetchOrder(args.id as string),
+ * });
+ * client.registerFunction(fn);
+ * ```
+ */
+declare interface ClientFunctionDefinition {
+    name: string;
+    description: string;
+    parameters: ClientFunctionSchema["parameters"];
+    handler: ClientFunctionHandler;
+}
+
+/**
+ * Function handler type
+ */
+declare type ClientFunctionHandler = (args: Record<string, unknown>) => Promise<unknown> | unknown;
+
+/**
+ * Schema for a client-side function that AGO can call
+ */
+declare interface ClientFunctionSchema {
+    /** Function name (must be unique) */
+    name: string;
+    /** Description for the LLM to understand when to call this function */
+    description: string;
+    /** JSON Schema for function parameters */
+    parameters: {
+        type: "object";
+        properties: Record<string, {
+            type: string;
+            description?: string;
+            enum?: string[];
+            default?: unknown;
+        }>;
+        required?: string[];
+    };
+}
+
+/**
+ * Copy text to clipboard.
+ */
+export declare const copyToClipboard: ClientFunctionDefinition;
+
+/**
+ * Get a value from localStorage.
+ */
+export declare const getLocalStorage: ClientFunctionDefinition;
+
+/**
+ * Get the user's geolocation.
+ */
+export declare const getUserLocation: ClientFunctionDefinition;
+
+/**
+ * Highlight an element on the page (useful for guided tours).
+ */
+export declare const highlightElement: ClientFunctionDefinition;
+
+/**
+ * Open a URL in a new tab.
+ */
+export declare const openUrl: ClientFunctionDefinition;
+
+/**
+ * Scroll to an element on the page.
+ */
+export declare const scrollToElement: ClientFunctionDefinition;
+
+/**
+ * Set a value in localStorage.
+ */
+export declare const setLocalStorage: ClientFunctionDefinition;
+
+/**
+ * Set the application theme (light/dark/system).
+ * Default handler toggles a `data-theme` attribute on `<html>`.
+ */
+export declare const setTheme: ClientFunctionDefinition;
+
+/**
+ * Show a confirm dialog and return the user's choice.
+ */
+export declare const showConfirmDialog: ClientFunctionDefinition;
+
+/**
+ * Show a browser notification (requires permission).
+ */
+export declare const showNotification: ClientFunctionDefinition;
+
+/**
+ * Show a toast/notification to the user.
+ * The handler is a no-op by default — wire it up to your toast library.
+ *
+ * ```ts
+ * import { showToast } from "@useago/sdk/helpers";
+ * showToast.handler = async (args) => { myToast(args.message); return { shown: true }; };
+ * client.registerFunction(showToast);
+ * ```
+ */
+export declare const showToast: ClientFunctionDefinition;
+
+/**
+ * Submit a form on the page programmatically.
+ */
+export declare const submitForm: ClientFunctionDefinition;
+
+/**
+ * Track a custom analytics event.
+ * Default handler logs to console — replace with your analytics provider.
+ */
+export declare const trackEvent: ClientFunctionDefinition;
+
+export { }

package/dist/helpers.d.ts

@@ -1,2 +1,121 @@
-export * from './helpers/index'
-export {}
+/**
+ * Single-object function definition — combines name, schema, and handler.
+ *
+ * ```ts
+ * const fn = defineFunction({
+ *   name: "lookupOrder",
+ *   description: "Look up an order by ID",
+ *   parameters: { type: "object", properties: { id: { type: "string" } }, required: ["id"] },
+ *   handler: async (args) => fetchOrder(args.id as string),
+ * });
+ * client.registerFunction(fn);
+ * ```
+ */
+declare interface ClientFunctionDefinition {
+    name: string;
+    description: string;
+    parameters: ClientFunctionSchema["parameters"];
+    handler: ClientFunctionHandler;
+}
+
+/**
+ * Function handler type
+ */
+declare type ClientFunctionHandler = (args: Record<string, unknown>) => Promise<unknown> | unknown;
+
+/**
+ * Schema for a client-side function that AGO can call
+ */
+declare interface ClientFunctionSchema {
+    /** Function name (must be unique) */
+    name: string;
+    /** Description for the LLM to understand when to call this function */
+    description: string;
+    /** JSON Schema for function parameters */
+    parameters: {
+        type: "object";
+        properties: Record<string, {
+            type: string;
+            description?: string;
+            enum?: string[];
+            default?: unknown;
+        }>;
+        required?: string[];
+    };
+}
+
+/**
+ * Copy text to clipboard.
+ */
+export declare const copyToClipboard: ClientFunctionDefinition;
+
+/**
+ * Get a value from localStorage.
+ */
+export declare const getLocalStorage: ClientFunctionDefinition;
+
+/**
+ * Get the user's geolocation.
+ */
+export declare const getUserLocation: ClientFunctionDefinition;
+
+/**
+ * Highlight an element on the page (useful for guided tours).
+ */
+export declare const highlightElement: ClientFunctionDefinition;
+
+/**
+ * Open a URL in a new tab.
+ */
+export declare const openUrl: ClientFunctionDefinition;
+
+/**
+ * Scroll to an element on the page.
+ */
+export declare const scrollToElement: ClientFunctionDefinition;
+
+/**
+ * Set a value in localStorage.
+ */
+export declare const setLocalStorage: ClientFunctionDefinition;
+
+/**
+ * Set the application theme (light/dark/system).
+ * Default handler toggles a `data-theme` attribute on `<html>`.
+ */
+export declare const setTheme: ClientFunctionDefinition;
+
+/**
+ * Show a confirm dialog and return the user's choice.
+ */
+export declare const showConfirmDialog: ClientFunctionDefinition;
+
+/**
+ * Show a browser notification (requires permission).
+ */
+export declare const showNotification: ClientFunctionDefinition;
+
+/**
+ * Show a toast/notification to the user.
+ * The handler is a no-op by default — wire it up to your toast library.
+ *
+ * ```ts
+ * import { showToast } from "@useago/sdk/helpers";
+ * showToast.handler = async (args) => { myToast(args.message); return { shown: true }; };
+ * client.registerFunction(showToast);
+ * ```
+ */
+export declare const showToast: ClientFunctionDefinition;
+
+/**
+ * Submit a form on the page programmatically.
+ */
+export declare const submitForm: ClientFunctionDefinition;
+
+/**
+ * Track a custom analytics event.
+ * Default handler logs to console — replace with your analytics provider.
+ */
+export declare const trackEvent: ClientFunctionDefinition;
+
+export { }

package/dist/helpers.js

@@ -1,2 +1,16 @@
-import { a as highlightElement, c as setLocalStorage, d as showNotification, f as showToast, i as getUserLocation, l as setTheme, m as trackEvent, o as openUrl, p as submitForm, r as getLocalStorage, s as scrollToElement, t as copyToClipboard, u as showConfirmDialog } from "./functions-C9F1dnmh.js";
-export { copyToClipboard, getLocalStorage, getUserLocation, highlightElement, openUrl, scrollToElement, setLocalStorage, setTheme, showConfirmDialog, showNotification, showToast, submitForm, trackEvent };
+import { a, c as s, d as t, f as e, i as r, l as i, m as l, o as m, p as c, r as g, s as h, t as n, u as p } from "./functions-CWSRi3xv.js";
+export {
+  n as copyToClipboard,
+  g as getLocalStorage,
+  r as getUserLocation,
+  a as highlightElement,
+  m as openUrl,
+  h as scrollToElement,
+  s as setLocalStorage,
+  i as setTheme,
+  p as showConfirmDialog,
+  t as showNotification,
+  e as showToast,
+  c as submitForm,
+  l as trackEvent
+};