@useago/sdk 1.0.0 → 1.0.1

package/dist/index.d.cts

@@ -64,6 +64,13 @@ export declare class AgoClient {
      * Reject a tool call
      */
     rejectToolCall(toolCallId: string): Promise<void>;
+    /**
+     * Fetch a backend-stored form collector definition by name (the single source
+     * of truth for the form's description, schema, and submit target). Used by
+     * `loadFormCollector` / the name-only form of `useFormCollector` so the schema
+     * lives in the backend instead of being hardcoded in client code.
+     */
+    getFormCollector(name: string): Promise<FormCollectorDefinition>;
     /**
      * Relay a completed form collector's values to a server-configured destination.
      *
@@ -814,6 +821,22 @@ export declare interface FormCollector<V = Record<string, unknown>> {
     getValues: () => Partial<V>;
     setValues: (patch: Partial<V>) => void;
     reset: () => void;
+    /** Completeness status (`missing`/`complete`) derived from the current values + schema. */
+    getStatus: () => FormCollectorStatus;
+}
+
+/**
+ * The backend-stored shape returned by `GET /api/sdk/v1/forms/{name}` (see
+ * {@link AgoClient.getFormCollector}). Mirrors the persistable subset of
+ * {@link CreateFormCollectorOptions}: the `submit` here is never the client-only
+ * `handler` variant (a function can't be stored server-side).
+ */
+export declare interface FormCollectorDefinition<V = Record<string, unknown>> {
+    name: string;
+    description: string;
+    schema: FormCollectorSchema;
+    /** Server-stored submit target, if any. Absent means collect-only. */
+    submit?: SubmitConfig<V>;
 }
 
 /**
@@ -988,6 +1011,30 @@ export declare const highlightElement: ClientFunctionDefinition;
  */
 export declare function isStreamNetworkError(error: Error): boolean;
 
+/**
+ * Async sibling of {@link createFormCollector} that pulls the form's definition
+ * (description + schema + submit target) from the backend by name — the single
+ * source of truth — instead of hardcoding it in client code. Any field passed in
+ * `options` overrides the fetched one (e.g. a client-only `submit` handler or
+ * `initialValues`).
+ *
+ * ```ts
+ * const order = await loadFormCollector(client, { name: "order" });
+ * order.install(client);
+ * ```
+ */
+export declare function loadFormCollector<V = Record<string, unknown>>(client: Pick<AgoClient, "getFormCollector">, options: LoadFormCollectorOptions<V>): Promise<FormCollector<V>>;
+
+/**
+ * Options for {@link loadFormCollector} / the name-only form of `useFormCollector`:
+ * the `name` is required and the definition is fetched from the backend, while any
+ * field here overrides the fetched one — notably a client-only `submit` handler,
+ * which can't be stored server-side.
+ */
+export declare interface LoadFormCollectorOptions<V = Record<string, unknown>> extends Partial<Omit<CreateFormCollectorOptions<V>, "name">> {
+    name: string;
+}
+
 /**
  * Debug logger for SDK
  */

package/dist/index.d.ts

@@ -64,6 +64,13 @@ export declare class AgoClient {
      * Reject a tool call
      */
     rejectToolCall(toolCallId: string): Promise<void>;
+    /**
+     * Fetch a backend-stored form collector definition by name (the single source
+     * of truth for the form's description, schema, and submit target). Used by
+     * `loadFormCollector` / the name-only form of `useFormCollector` so the schema
+     * lives in the backend instead of being hardcoded in client code.
+     */
+    getFormCollector(name: string): Promise<FormCollectorDefinition>;
     /**
      * Relay a completed form collector's values to a server-configured destination.
      *
@@ -814,6 +821,22 @@ export declare interface FormCollector<V = Record<string, unknown>> {
     getValues: () => Partial<V>;
     setValues: (patch: Partial<V>) => void;
     reset: () => void;
+    /** Completeness status (`missing`/`complete`) derived from the current values + schema. */
+    getStatus: () => FormCollectorStatus;
+}
+
+/**
+ * The backend-stored shape returned by `GET /api/sdk/v1/forms/{name}` (see
+ * {@link AgoClient.getFormCollector}). Mirrors the persistable subset of
+ * {@link CreateFormCollectorOptions}: the `submit` here is never the client-only
+ * `handler` variant (a function can't be stored server-side).
+ */
+export declare interface FormCollectorDefinition<V = Record<string, unknown>> {
+    name: string;
+    description: string;
+    schema: FormCollectorSchema;
+    /** Server-stored submit target, if any. Absent means collect-only. */
+    submit?: SubmitConfig<V>;
 }
 
 /**
@@ -988,6 +1011,30 @@ export declare const highlightElement: ClientFunctionDefinition;
  */
 export declare function isStreamNetworkError(error: Error): boolean;
 
+/**
+ * Async sibling of {@link createFormCollector} that pulls the form's definition
+ * (description + schema + submit target) from the backend by name — the single
+ * source of truth — instead of hardcoding it in client code. Any field passed in
+ * `options` overrides the fetched one (e.g. a client-only `submit` handler or
+ * `initialValues`).
+ *
+ * ```ts
+ * const order = await loadFormCollector(client, { name: "order" });
+ * order.install(client);
+ * ```
+ */
+export declare function loadFormCollector<V = Record<string, unknown>>(client: Pick<AgoClient, "getFormCollector">, options: LoadFormCollectorOptions<V>): Promise<FormCollector<V>>;
+
+/**
+ * Options for {@link loadFormCollector} / the name-only form of `useFormCollector`:
+ * the `name` is required and the definition is fetched from the backend, while any
+ * field here overrides the fetched one — notably a client-only `submit` handler,
+ * which can't be stored server-side.
+ */
+export declare interface LoadFormCollectorOptions<V = Record<string, unknown>> extends Partial<Omit<CreateFormCollectorOptions<V>, "name">> {
+    name: string;
+}
+
 /**
  * Debug logger for SDK
  */

package/dist/index.js

@@ -1,31 +1,31 @@
-import { a as w, c as h, d as A, f as y, i as C, l as E, n as S, o as b, r as v, s as k, t as d, u as M } from "./AgoClient-BrYhSO5M.js";
-import { n as T, r as I, t as U } from "./createFormCollector-CPS2phYq.js";
-import { t as O } from "./createConversationSession-Dmqd80DX.js";
-import { t as x } from "./createMockClient-DwdxNwEn.js";
+import { a as w, c as h, d as A, f as y, i as C, l as E, n as S, o as b, r as v, s as k, t as d, u as F } from "./AgoClient-CZYNL25R.js";
+import { i as T, n as I, r as U, t as G } from "./createFormCollector-Bk0DRhUf.js";
+import { t as q } from "./createConversationSession-Bmqj2rSS.js";
+import { t as L } from "./createMockClient-DwdxNwEn.js";
 import "./testing.js";
-import { a as D, c as H, d as J, f as R, i as j, l as B, m as P, o as $, p as z, r as K, s as Q, t as V, u as W } from "./functions-C1-5vadY.js";
-function X(e) {
+import { a as H, c as J, d as R, f as j, i as B, l as P, m as $, o as z, p as K, r as Q, s as V, t as W, u as X } from "./functions-C1-5vadY.js";
+function Y(e) {
   return e;
 }
-function Y(e, t) {
-  return e.on("message:complete", t), () => e.off("message:complete", t);
+function Z(e, o) {
+  return e.on("message:complete", o), () => e.off("message:complete", o);
 }
-function Z(e, t) {
-  return e.on("message:chunk", t), () => e.off("message:chunk", t);
+function _(e, o) {
+  return e.on("message:chunk", o), () => e.off("message:chunk", o);
 }
-function _(e, t) {
-  return e.on("message:start", t), () => e.off("message:start", t);
+function ee(e, o) {
+  return e.on("message:start", o), () => e.off("message:start", o);
 }
-function ee(e, t) {
-  return e.on("message:error", t), () => e.off("message:error", t);
+function oe(e, o) {
+  return e.on("message:error", o), () => e.off("message:error", o);
 }
-function te(e, t) {
-  return e.on("toolCall:received", t), () => e.off("toolCall:received", t);
+function te(e, o) {
+  return e.on("toolCall:received", o), () => e.off("toolCall:received", o);
 }
-function oe(e, t) {
-  return e.on("function:invoke", t), () => e.off("function:invoke", t);
+function re(e, o) {
+  return e.on("function:invoke", o), () => e.off("function:invoke", o);
 }
-async function* re(e, t, g) {
+async function* ae(e, o, g) {
   const a = [];
   let r = null, n = !1;
   const u = (s) => {
@@ -33,7 +33,7 @@ async function* re(e, t, g) {
   }, f = (s) => u({
     type: "start",
     data: s
-  }), o = (s) => u({
+  }), t = (s) => u({
     type: "chunk",
     data: s
   }), i = (s) => {
@@ -50,7 +50,7 @@ async function* re(e, t, g) {
     type: "toolCall",
     data: s
   });
-  e.on("message:start", f), e.on("message:chunk", o), e.on("message:complete", i), e.on("message:error", m), e.on("toolCall:received", l), e.sendMessage(t, g).catch(() => {
+  e.on("message:start", f), e.on("message:chunk", t), e.on("message:complete", i), e.on("message:error", m), e.on("toolCall:received", l), e.sendMessage(o, g).catch(() => {
     n = !0, r?.();
   });
   try {
@@ -58,28 +58,28 @@ async function* re(e, t, g) {
       r = s;
     }), r = null);
   } finally {
-    e.off("message:start", f), e.off("message:chunk", o), e.off("message:complete", i), e.off("message:error", m), e.off("toolCall:received", l);
+    e.off("message:start", f), e.off("message:chunk", t), e.off("message:complete", i), e.off("message:error", m), e.off("toolCall:received", l);
   }
 }
 function c(e) {
-  let t, g, a, r, n, u;
+  let o, g, a, r, n, u;
   if (typeof window < "u" && window.AGO) {
-    const o = window.AGO;
-    t = o.basepath, g = o.widgetId, a = o.agent || o.defaultAgent, r = o.permission, n = o.email, u = o.jwt;
+    const t = window.AGO;
+    o = t.basepath, g = t.widgetId, a = t.agent || t.defaultAgent, r = t.permission, n = t.email, u = t.jwt;
   }
   if (typeof document < "u") {
-    const o = (i) => document.querySelector(`meta[name="${i}"]`)?.getAttribute("content") || void 0;
-    t = t || o("ago-base-url"), g = g || o("ago-widget-id"), a = a || o("ago-agent") || o("ago-agent-id"), r = r || o("ago-permission"), n = n || o("ago-user-email");
+    const t = (i) => document.querySelector(`meta[name="${i}"]`)?.getAttribute("content") || void 0;
+    o = o || t("ago-base-url"), g = g || t("ago-widget-id"), a = a || t("ago-agent") || t("ago-agent-id"), r = r || t("ago-permission"), n = n || t("ago-user-email");
   }
   if (typeof document < "u") {
-    const o = [document.body, ...Array.from(document.querySelectorAll("script[data-ago-base-url]"))].filter(Boolean);
-    for (const i of o)
-      i && (t = t || i.getAttribute("data-ago-base-url") || void 0, g = g || i.getAttribute("data-ago-widget-id") || void 0, a = a || i.getAttribute("data-ago-agent") || i.getAttribute("data-ago-agent-id") || void 0, r = r || i.getAttribute("data-ago-permission") || void 0, n = n || i.getAttribute("data-ago-user-email") || void 0);
+    const t = [document.body, ...Array.from(document.querySelectorAll("script[data-ago-base-url]"))].filter(Boolean);
+    for (const i of t)
+      i && (o = o || i.getAttribute("data-ago-base-url") || void 0, g = g || i.getAttribute("data-ago-widget-id") || void 0, a = a || i.getAttribute("data-ago-agent") || i.getAttribute("data-ago-agent-id") || void 0, r = r || i.getAttribute("data-ago-permission") || void 0, n = n || i.getAttribute("data-ago-user-email") || void 0);
   }
-  t = e?.baseUrl || t, g = e?.widgetId || g, a = e?.agent || e?.defaultAgentId || a, r = e?.permission || r, n = e?.userEmail || n, u = e?.userJwt || u;
+  o = e?.baseUrl || o, g = e?.widgetId || g, a = e?.agent || e?.defaultAgentId || a, r = e?.permission || r, n = e?.userEmail || n, u = e?.userJwt || u;
   const f = e?.debug;
-  return t ? {
-    baseUrl: t,
+  return o ? {
+    baseUrl: o,
     widgetId: g,
     agent: a,
     permission: r,
@@ -88,22 +88,22 @@ function c(e) {
     debug: f
   } : null;
 }
-function ae(e) {
-  const t = c(e);
-  if (!t) throw new Error('createAgo(): could not detect AGO configuration. Set window.AGO, add <meta name="ago-base-url">, or pass { baseUrl } explicitly.');
-  return new d(t);
+function ne(e) {
+  const o = c(e);
+  if (!o) throw new Error('createAgo(): could not detect AGO configuration. Set window.AGO, add <meta name="ago-base-url">, or pass { baseUrl } explicitly.');
+  return new d(o);
 }
-function ne(e, t) {
+function se(e, o) {
   return {
     ...e,
-    handler: t
+    handler: o
   };
 }
 export {
   h as AgoApiError,
   d as AgoClient,
   E as AgoError,
-  M as AgoFunctionError,
+  F as AgoFunctionError,
   A as AgoNetworkError,
   y as AgoStreamError,
   w as ClientContextRegistry,
@@ -111,34 +111,35 @@ export {
   b as FunctionRegistry,
   v as SSEHandler,
   c as autoDetectConfig,
-  V as copyToClipboard,
-  ae as createAgo,
-  O as createConversationSession,
-  U as createFormCollector,
-  re as createMessageStream,
-  x as createMockClient,
-  I as createStore,
-  X as defineFunction,
-  T as deriveFormStatus,
-  K as getLocalStorage,
-  j as getUserLocation,
-  D as highlightElement,
+  W as copyToClipboard,
+  ne as createAgo,
+  q as createConversationSession,
+  G as createFormCollector,
+  ae as createMessageStream,
+  L as createMockClient,
+  T as createStore,
+  Y as defineFunction,
+  I as deriveFormStatus,
+  Q as getLocalStorage,
+  B as getUserLocation,
+  H as highlightElement,
   C as isStreamNetworkError,
+  U as loadFormCollector,
   k as logger,
-  oe as onFunctionInvoke,
-  Y as onMessage,
-  Z as onMessageChunk,
-  ee as onMessageError,
-  _ as onMessageStart,
+  re as onFunctionInvoke,
+  Z as onMessage,
+  _ as onMessageChunk,
+  oe as onMessageError,
+  ee as onMessageStart,
   te as onToolCall,
-  $ as openUrl,
-  Q as scrollToElement,
-  H as setLocalStorage,
-  B as setTheme,
-  W as showConfirmDialog,
-  J as showNotification,
-  R as showToast,
-  z as submitForm,
-  P as trackEvent,
-  ne as withHandler
+  z as openUrl,
+  V as scrollToElement,
+  J as setLocalStorage,
+  P as setTheme,
+  X as showConfirmDialog,
+  R as showNotification,
+  j as showToast,
+  K as submitForm,
+  $ as trackEvent,
+  se as withHandler
 };