@useago/sdk 1.0.0 → 1.0.1

package/dist/angular.d.ts

@@ -53,6 +53,13 @@ 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.
      *
@@ -477,6 +484,30 @@ export declare interface Conversation {
  */
 declare type DynamicContextProvider = () => ContextEntry | null | undefined;
 
+/**
+ * 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).
+ */
+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>;
+}
+
+/**
+ * Shape of a form's fields. Mirrors a client function's `parameters` (so the same
+ * object feeds the store, the update function, and the dynamic context). Additionally allows the SDK-only per-field `requiredWhen`, which {@link toWireParameters} removes before the schema reaches the LLM.
+ */
+declare interface FormCollectorSchema {
+    type: "object";
+    properties: Record<string, FormFieldSchema>;
+    required?: string[];
+}
+
 declare interface FormField {
     type: "string" | "number" | "boolean" | "array";
     title?: string;
@@ -485,6 +516,43 @@ declare interface FormField {
     default?: unknown;
 }
 
+/**
+ * A field's conditional-requiredness rule. The field becomes required exactly
+ * when the controlling `property` matches `value` against the answers collected
+ * so far:
+ * - a single `value`, no `op` — equality (compared as strings);
+ * - a single `value` with `op` — numeric comparison (both sides coerced to numbers);
+ * - an array `value`, no `op` — "one of": matches when the property equals any
+ *   listed value.
+ *
+ * SDK-only — it is stripped from the schema before it reaches the LLM tool
+ */
+declare interface FormFieldCondition {
+    /** The controlling field whose value the rule tests. */
+    property: string;
+    /** Comparison operator; omitted means equality. Ignored when `value` is an array. */
+    op?: ">=" | "<=" | ">" | "<";
+    /**
+     * The value(s) to test the controlling field against. A single value is an
+     * equality (or, with `op`, a numeric comparison); an array is an "is one of"
+     * membership test, e.g. `value: ["1", "2", "3"]`.
+     */
+    value: string | number | Array<string | number>;
+}
+
+/** A single field's schema: the wire-legal keys plus the SDK-only `requiredWhen`. */
+declare interface FormFieldSchema {
+    type: string;
+    description?: string;
+    enum?: string[];
+    default?: unknown;
+    /**
+     * Makes the field required only while this condition holds. Drives the dynamic
+     * `missing` list; stripped before the LLM tool — see {@link toWireParameters}.
+     */
+    requiredWhen?: FormFieldCondition;
+}
+
 /**
  * Form schema for tool calls requiring user input
  */
@@ -541,6 +609,27 @@ declare interface SendMessageOptions {
     files?: File[];
 }
 
+/**
+ * Where a completed form is sent.
+ * - `"https://..."` (a bare string) — shorthand for `{ via: "client", url }`: the browser
+ *   POSTs the values to that URL.
+ * - `{ via: "client", url }` — same, written out.
+ * - `{ via: "client", handler }` — the browser runs your own submit logic.
+ * - `{ via: "backend", destination }` — the browser relays the values to the backend,
+ *   which forwards them to the server-configured destination (URL + secret stay server-side).
+ * - `false` — collect only, no submit function.
+ */
+declare type SubmitConfig<V = Record<string, unknown>> = string | {
+    via: "client";
+    url: string;
+} | {
+    via: "client";
+    handler: (values: V) => Promise<unknown> | unknown;
+} | {
+    via: "backend";
+    destination: string;
+} | false;
+
 /**
  * Tool call data from SSE stream
  */

package/dist/angular.js

@@ -1,4 +1,4 @@
-import { t as o } from "./AgoClient-BrYhSO5M.js";
+import { t as o } from "./AgoClient-CZYNL25R.js";
 var n = class {
   constructor(t) {
     this.client = new o(t), this.messages$ = this.fromEvent("message:complete"), this.chunks$ = this.fromEvent("message:chunk"), this.errors$ = this.fromEvent("message:error"), this.messageStart$ = this.fromEvent("message:start");

package/dist/{createConversationSession-CGRO0bs2.cjs → createConversationSession-BLZvXMmM.cjs}

@@ -1 +1 @@
-const d=require("./createFormCollector-DaWZsBsI.cjs");var f="ago_widget_id",g="ago_last_thread",y=7200*1e3;function v(){return typeof crypto<"u"&&typeof crypto.randomUUID=="function"?crypto.randomUUID():"xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g,e=>{const r=Math.floor(Math.random()*16);return(e==="x"?r:r&3|8).toString(16)})}function _(e={}){const r=e.key??f,i=e.threadKey??g,u=e.ttlMs??y,l=e.storage??(typeof localStorage<"u"?localStorage:void 0);let n=e.widgetId??"";if(!n&&l)try{n=l.getItem(r)??""}catch{}if(n||(n=v()),l)try{l.setItem(r,n)}catch{}const o=d.createStore({value:null,lastMessageAt:null},{key:i,storage:l}),c=o.get();c.value!==null&&s(c.lastMessageAt)&&o.set({value:null,lastMessageAt:null});function s(t){return t===null?!0:Number.isFinite(u)?Date.now()-t>u:!1}return{widgetId:n,key:r,getLastActiveThread(){const{value:t,lastMessageAt:a}=o.get();return t===null||s(a)?null:t},setActiveThread(t,a){const x=a==null?null:a instanceof Date?a.getTime():a;o.set({value:t,lastMessageAt:x})},clear(){o.set({value:null,lastMessageAt:null})}}}Object.defineProperty(exports,"createConversationSession",{enumerable:!0,get:function(){return _}});
+const d=require("./createFormCollector-Ca8wRrxc.cjs");var f="ago_widget_id",g="ago_last_thread",y=7200*1e3;function v(){return typeof crypto<"u"&&typeof crypto.randomUUID=="function"?crypto.randomUUID():"xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g,e=>{const r=Math.floor(Math.random()*16);return(e==="x"?r:r&3|8).toString(16)})}function _(e={}){const r=e.key??f,i=e.threadKey??g,u=e.ttlMs??y,l=e.storage??(typeof localStorage<"u"?localStorage:void 0);let n=e.widgetId??"";if(!n&&l)try{n=l.getItem(r)??""}catch{}if(n||(n=v()),l)try{l.setItem(r,n)}catch{}const o=d.createStore({value:null,lastMessageAt:null},{key:i,storage:l}),c=o.get();c.value!==null&&s(c.lastMessageAt)&&o.set({value:null,lastMessageAt:null});function s(t){return t===null?!0:Number.isFinite(u)?Date.now()-t>u:!1}return{widgetId:n,key:r,getLastActiveThread(){const{value:t,lastMessageAt:a}=o.get();return t===null||s(a)?null:t},setActiveThread(t,a){const x=a==null?null:a instanceof Date?a.getTime():a;o.set({value:t,lastMessageAt:x})},clear(){o.set({value:null,lastMessageAt:null})}}}Object.defineProperty(exports,"createConversationSession",{enumerable:!0,get:function(){return _}});

package/dist/{createConversationSession-Dmqd80DX.js → createConversationSession-Bmqj2rSS.js}

@@ -1,4 +1,4 @@
-import { r as d } from "./createFormCollector-CPS2phYq.js";
+import { i as d } from "./createFormCollector-Bk0DRhUf.js";
 var f = "ago_widget_id", g = "ago_last_thread", y = 7200 * 1e3;
 function v() {
   return typeof crypto < "u" && typeof crypto.randomUUID == "function" ? crypto.randomUUID() : "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, (e) => {

package/dist/createFormCollector-Bk0DRhUf.js

@@ -0,0 +1,257 @@
+import { s as _ } from "./AgoClient-CZYNL25R.js";
+function E(n, e) {
+  const i = e ? e.storage ?? (typeof localStorage < "u" ? localStorage : void 0) : void 0;
+  let t = n;
+  if (e && i) try {
+    const c = i.getItem(e.key);
+    c != null && (t = JSON.parse(c));
+  } catch {
+  }
+  const a = /* @__PURE__ */ new Set(), f = () => a.forEach((c) => c(t));
+  function d() {
+    if (e && i) try {
+      i.setItem(e.key, JSON.stringify(t));
+    } catch {
+    }
+  }
+  return {
+    get: () => t,
+    set: (c) => {
+      t = c, d(), f();
+    },
+    subscribe: (c) => (a.add(c), () => {
+      a.delete(c);
+    })
+  };
+}
+var F = /^[a-zA-Z0-9_-]{1,40}$/, O = (n) => n == null || n === "";
+function q(n, e) {
+  const i = e[n.property];
+  if (O(i)) return !1;
+  if (Array.isArray(n.value)) return n.value.some((f) => String(i) === String(f));
+  if (!n.op) return String(i) === String(n.value);
+  const t = Number(i), a = Number(n.value);
+  if (Number.isNaN(t) || Number.isNaN(a)) return !1;
+  switch (n.op) {
+    case ">=":
+      return t >= a;
+    case "<=":
+      return t <= a;
+    case ">":
+      return t > a;
+    case "<":
+      return t < a;
+    default:
+      return _.warn(`Unknown requiredWhen op "${n.op}"; treating as not required.`), !1;
+  }
+}
+function g(n, e) {
+  const i = n.properties ?? {}, t = /* @__PURE__ */ new Set();
+  for (const f of n.required ?? []) {
+    const d = i[f]?.requiredWhen;
+    (!d || q(d, e)) && t.add(f);
+  }
+  for (const [f, d] of Object.entries(i)) d.requiredWhen && q(d.requiredWhen, e) && t.add(f);
+  const a = [...t].filter((f) => O(e[f]));
+  return {
+    missing: a,
+    complete: a.length === 0
+  };
+}
+function P(n) {
+  const e = {};
+  for (const [i, t] of Object.entries(n.properties ?? {})) e[i] = {
+    type: t.type,
+    ...t.description != null && { description: t.description },
+    ...t.enum && { enum: t.enum },
+    ...t.default !== void 0 && { default: t.default }
+  };
+  return {
+    type: "object",
+    properties: e,
+    required: []
+  };
+}
+function W(n) {
+  const { name: e, description: i, schema: t } = n;
+  if (!F.test(e)) throw new Error(`Invalid form collector name "${e}": must match ${F} (it becomes the update_/submit_ function names).`);
+  const a = typeof n.submit == "string" ? n.submit ? {
+    via: "client",
+    url: n.submit
+  } : !1 : n.submit ?? !1, f = t.properties ?? {}, d = (r) => {
+    const s = {};
+    for (const [u, o] of Object.entries(r)) {
+      const l = f[u];
+      if (l)
+        if (o == null) s[u] = o;
+        else if (l.type === "number" || l.type === "integer") {
+          const h = typeof o == "number" ? o : Number(o);
+          s[u] = Number.isNaN(h) ? o : h;
+        } else l.type === "boolean" ? s[u] = typeof o == "boolean" ? o : o === "true" ? !0 : o === "false" ? !1 : !!o : s[u] = o;
+    }
+    return s;
+  }, c = n.initialValues ?? {}, m = E({
+    values: c,
+    submitted: !1
+  }), v = (r) => {
+    const s = m.get(), u = {
+      ...s,
+      values: {
+        ...s.values,
+        ...r
+      }
+    };
+    return m.set(u), u;
+  };
+  let b = null;
+  const N = async () => {
+    const { values: r } = m.get(), { complete: s, missing: u } = g(t, r);
+    if (!s) return {
+      ok: !1,
+      missing: u
+    };
+    if (!a) return {
+      ok: !1,
+      error: "No submit target configured for this form collector."
+    };
+    const o = r;
+    try {
+      let l;
+      if (a.via === "client") if ("handler" in a) l = await a.handler(o);
+      else {
+        const h = await fetch(a.url, {
+          method: "POST",
+          headers: { "Content-Type": "application/json" },
+          credentials: "include",
+          body: JSON.stringify(o)
+        });
+        if (!h.ok) return {
+          ok: !1,
+          error: `Submit failed: HTTP ${h.status}`
+        };
+        l = await h.json().catch(() => {
+        });
+      }
+      else {
+        if (!b) return {
+          ok: !1,
+          error: "Backend submit requires install(client) (or useFormCollector) first."
+        };
+        l = await b.submitFormCollector(a.destination, o);
+      }
+      return m.set({
+        ...m.get(),
+        submitted: !0
+      }), {
+        ok: !0,
+        result: l
+      };
+    } catch (l) {
+      const h = l instanceof Error ? l.message : "Submit failed";
+      return _.error(`FormCollector "${e}" submit failed:`, l), {
+        ok: !1,
+        error: h
+      };
+    }
+  }, $ = {
+    name: `update_${e}`,
+    description: `Fill or update fields of the "${e}" form. ${i} Pass any subset of fields; call it repeatedly to fill the form as the user provides information. Returns the current values and which required fields are still missing.`,
+    parameters: P(t),
+    handler: (r) => {
+      const s = v(d(r)), { missing: u } = g(t, s.values);
+      return {
+        ok: !0,
+        values: s.values,
+        missing: u
+      };
+    }
+  }, p = [$];
+  a && p.push({
+    name: `submit_${e}`,
+    description: `Submit the completed "${e}" form. Only call this once every required field is collected and the user has confirmed. If fields are missing it returns them instead of submitting.`,
+    parameters: {
+      type: "object",
+      properties: {}
+    },
+    handler: () => N()
+  });
+  const T = "client__", S = a ? `submit_${e}` : null, x = (r) => {
+    const s = r.functionName ?? r.toolName;
+    if (s)
+      return s.startsWith(T) ? s.slice(8) : s;
+  }, w = (r) => {
+    let s = { ...c }, u = !1;
+    for (const o of r) {
+      const l = x(o);
+      l === $.name ? o.arguments && (s = {
+        ...s,
+        ...d(o.arguments)
+      }) : S && l === S && o.status?.toLowerCase() === "done" && (u = !0);
+    }
+    m.set({
+      values: s,
+      submitted: u
+    });
+  }, y = `form:${e}`, C = () => {
+    const { values: r, submitted: s } = m.get(), { missing: u, complete: o } = g(t, r), l = a ? ` When nothing is missing and the user confirms, call submit_${e}.` : "", h = s ? `The "${e}" form has been submitted.` : `You are currently collecting information from the user to fill the "${e}" form.`;
+    return {
+      name: `Form: ${e}`,
+      description: `${h} ${i} There are conditionnals questions/values to collected, you can find this information with the requiredWhen field in the form. The form schema is the following: ${JSON.stringify(t)}. Data collected so far: ${JSON.stringify(r)}. Call update_${e} with any fields the user provides; ask only for what is still missing.${l}`,
+      data: {
+        values: r,
+        missing: u,
+        complete: o,
+        submitted: s
+      }
+    };
+  }, k = (r) => {
+    w((r.messages ?? []).flatMap((s) => s.toolCalls ?? []));
+  };
+  return {
+    name: e,
+    store: m,
+    functions: p,
+    contextKey: y,
+    contextProvider: C,
+    install: (r) => {
+      b = r;
+      for (const u of p) r.register(u);
+      r.addDynamicContext(y, C);
+      const s = m.subscribe(() => r.notifyContextChanged());
+      return r.on("conversation:loaded", k), () => {
+        s();
+        for (const u of p) r.unregisterFunction(u.name);
+        r.removeDynamicContext(y), r.off("conversation:loaded", k), b === r && (b = null);
+      };
+    },
+    hydrate: w,
+    submit: N,
+    getValues: () => m.get().values,
+    setValues: (r) => {
+      v(d(r));
+    },
+    reset: () => {
+      m.set({
+        values: c,
+        submitted: !1
+      });
+    },
+    getStatus: () => g(t, m.get().values)
+  };
+}
+async function V(n, e) {
+  const i = await n.getFormCollector(e.name);
+  return W({
+    name: i.name,
+    description: e.description ?? i.description,
+    schema: e.schema ?? i.schema,
+    submit: e.submit ?? i.submit,
+    initialValues: e.initialValues
+  });
+}
+export {
+  E as i,
+  g as n,
+  V as r,
+  W as t
+};

package/dist/createFormCollector-Ca8wRrxc.cjs

@@ -0,0 +1 @@
+const O=require("./AgoClient-0x2Du_62.cjs");function _(o,e){const i=e?e.storage??(typeof localStorage<"u"?localStorage:void 0):void 0;let t=o;if(e&&i)try{const c=i.getItem(e.key);c!=null&&(t=JSON.parse(c))}catch{}const a=new Set,f=()=>a.forEach(c=>c(t));function d(){if(e&&i)try{i.setItem(e.key,JSON.stringify(t))}catch{}}return{get:()=>t,set:c=>{t=c,d(),f()},subscribe:c=>(a.add(c),()=>{a.delete(c)})}}var k=/^[a-zA-Z0-9_-]{1,40}$/,P=o=>o==null||o==="";function q(o,e){const i=e[o.property];if(P(i))return!1;if(Array.isArray(o.value))return o.value.some(f=>String(i)===String(f));if(!o.op)return String(i)===String(o.value);const t=Number(i),a=Number(o.value);if(Number.isNaN(t)||Number.isNaN(a))return!1;switch(o.op){case">=":return t>=a;case"<=":return t<=a;case">":return t>a;case"<":return t<a;default:return O.logger.warn(`Unknown requiredWhen op "${o.op}"; treating as not required.`),!1}}function p(o,e){const i=o.properties??{},t=new Set;for(const f of o.required??[]){const d=i[f]?.requiredWhen;(!d||q(d,e))&&t.add(f)}for(const[f,d]of Object.entries(i))d.requiredWhen&&q(d.requiredWhen,e)&&t.add(f);const a=[...t].filter(f=>P(e[f]));return{missing:a,complete:a.length===0}}function W(o){const e={};for(const[i,t]of Object.entries(o.properties??{}))e[i]={type:t.type,...t.description!=null&&{description:t.description},...t.enum&&{enum:t.enum},...t.default!==void 0&&{default:t.default}};return{type:"object",properties:e,required:[]}}function j(o){const{name:e,description:i,schema:t}=o;if(!k.test(e))throw new Error(`Invalid form collector name "${e}": must match ${k} (it becomes the update_/submit_ function names).`);const a=typeof o.submit=="string"?o.submit?{via:"client",url:o.submit}:!1:o.submit??!1,f=t.properties??{},d=r=>{const n={};for(const[u,s]of Object.entries(r)){const l=f[u];if(l)if(s==null)n[u]=s;else if(l.type==="number"||l.type==="integer"){const b=typeof s=="number"?s:Number(s);n[u]=Number.isNaN(b)?s:b}else l.type==="boolean"?n[u]=typeof s=="boolean"?s:s==="true"?!0:s==="false"?!1:!!s:n[u]=s}return n},c=o.initialValues??{},m=_({values:c,submitted:!1}),v=r=>{const n=m.get(),u={...n,values:{...n.values,...r}};return m.set(u),u};let h=null;const N=async()=>{const{values:r}=m.get(),{complete:n,missing:u}=p(t,r);if(!n)return{ok:!1,missing:u};if(!a)return{ok:!1,error:"No submit target configured for this form collector."};const s=r;try{let l;if(a.via==="client")if("handler"in a)l=await a.handler(s);else{const b=await fetch(a.url,{method:"POST",headers:{"Content-Type":"application/json"},credentials:"include",body:JSON.stringify(s)});if(!b.ok)return{ok:!1,error:`Submit failed: HTTP ${b.status}`};l=await b.json().catch(()=>{})}else{if(!h)return{ok:!1,error:"Backend submit requires install(client) (or useFormCollector) first."};l=await h.submitFormCollector(a.destination,s)}return m.set({...m.get(),submitted:!0}),{ok:!0,result:l}}catch(l){const b=l instanceof Error?l.message:"Submit failed";return O.logger.error(`FormCollector "${e}" submit failed:`,l),{ok:!1,error:b}}},S={name:`update_${e}`,description:`Fill or update fields of the "${e}" form. ${i} Pass any subset of fields; call it repeatedly to fill the form as the user provides information. Returns the current values and which required fields are still missing.`,parameters:W(t),handler:r=>{const n=v(d(r)),{missing:u}=p(t,n.values);return{ok:!0,values:n.values,missing:u}}},g=[S];a&&g.push({name:`submit_${e}`,description:`Submit the completed "${e}" form. Only call this once every required field is collected and the user has confirmed. If fields are missing it returns them instead of submitting.`,parameters:{type:"object",properties:{}},handler:()=>N()});const T="client__",C=a?`submit_${e}`:null,E=r=>{const n=r.functionName??r.toolName;if(n)return n.startsWith(T)?n.slice(8):n},$=r=>{let n={...c},u=!1;for(const s of r){const l=E(s);l===S.name?s.arguments&&(n={...n,...d(s.arguments)}):C&&l===C&&s.status?.toLowerCase()==="done"&&(u=!0)}m.set({values:n,submitted:u})},y=`form:${e}`,w=()=>{const{values:r,submitted:n}=m.get(),{missing:u,complete:s}=p(t,r),l=a?` When nothing is missing and the user confirms, call submit_${e}.`:"",b=n?`The "${e}" form has been submitted.`:`You are currently collecting information from the user to fill the "${e}" form.`;return{name:`Form: ${e}`,description:`${b} ${i} There are conditionnals questions/values to collected, you can find this information with the requiredWhen field in the form. The form schema is the following: ${JSON.stringify(t)}. Data collected so far: ${JSON.stringify(r)}. Call update_${e} with any fields the user provides; ask only for what is still missing.${l}`,data:{values:r,missing:u,complete:s,submitted:n}}},F=r=>{$((r.messages??[]).flatMap(n=>n.toolCalls??[]))};return{name:e,store:m,functions:g,contextKey:y,contextProvider:w,install:r=>{h=r;for(const u of g)r.register(u);r.addDynamicContext(y,w);const n=m.subscribe(()=>r.notifyContextChanged());return r.on("conversation:loaded",F),()=>{n();for(const u of g)r.unregisterFunction(u.name);r.removeDynamicContext(y),r.off("conversation:loaded",F),h===r&&(h=null)}},hydrate:$,submit:N,getValues:()=>m.get().values,setValues:r=>{v(d(r))},reset:()=>{m.set({values:c,submitted:!1})},getStatus:()=>p(t,m.get().values)}}async function x(o,e){const i=await o.getFormCollector(e.name);return j({name:i.name,description:e.description??i.description,schema:e.schema??i.schema,submit:e.submit??i.submit,initialValues:e.initialValues})}Object.defineProperty(exports,"createFormCollector",{enumerable:!0,get:function(){return j}});Object.defineProperty(exports,"createStore",{enumerable:!0,get:function(){return _}});Object.defineProperty(exports,"deriveFormStatus",{enumerable:!0,get:function(){return p}});Object.defineProperty(exports,"loadFormCollector",{enumerable:!0,get:function(){return x}});

package/dist/devtools.d.cts

@@ -53,6 +53,13 @@ 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.
      *
@@ -399,6 +406,30 @@ export declare interface DevPanelOptions {
  */
 declare type DynamicContextProvider = () => ContextEntry | null | undefined;
 
+/**
+ * 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).
+ */
+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>;
+}
+
+/**
+ * Shape of a form's fields. Mirrors a client function's `parameters` (so the same
+ * object feeds the store, the update function, and the dynamic context). Additionally allows the SDK-only per-field `requiredWhen`, which {@link toWireParameters} removes before the schema reaches the LLM.
+ */
+declare interface FormCollectorSchema {
+    type: "object";
+    properties: Record<string, FormFieldSchema>;
+    required?: string[];
+}
+
 declare interface FormField {
     type: "string" | "number" | "boolean" | "array";
     title?: string;
@@ -407,6 +438,43 @@ declare interface FormField {
     default?: unknown;
 }
 
+/**
+ * A field's conditional-requiredness rule. The field becomes required exactly
+ * when the controlling `property` matches `value` against the answers collected
+ * so far:
+ * - a single `value`, no `op` — equality (compared as strings);
+ * - a single `value` with `op` — numeric comparison (both sides coerced to numbers);
+ * - an array `value`, no `op` — "one of": matches when the property equals any
+ *   listed value.
+ *
+ * SDK-only — it is stripped from the schema before it reaches the LLM tool
+ */
+declare interface FormFieldCondition {
+    /** The controlling field whose value the rule tests. */
+    property: string;
+    /** Comparison operator; omitted means equality. Ignored when `value` is an array. */
+    op?: ">=" | "<=" | ">" | "<";
+    /**
+     * The value(s) to test the controlling field against. A single value is an
+     * equality (or, with `op`, a numeric comparison); an array is an "is one of"
+     * membership test, e.g. `value: ["1", "2", "3"]`.
+     */
+    value: string | number | Array<string | number>;
+}
+
+/** A single field's schema: the wire-legal keys plus the SDK-only `requiredWhen`. */
+declare interface FormFieldSchema {
+    type: string;
+    description?: string;
+    enum?: string[];
+    default?: unknown;
+    /**
+     * Makes the field required only while this condition holds. Drives the dynamic
+     * `missing` list; stripped before the LLM tool — see {@link toWireParameters}.
+     */
+    requiredWhen?: FormFieldCondition;
+}
+
 /**
  * Form schema for tool calls requiring user input
  */
@@ -432,6 +500,27 @@ declare interface SendMessageOptions {
     files?: File[];
 }
 
+/**
+ * Where a completed form is sent.
+ * - `"https://..."` (a bare string) — shorthand for `{ via: "client", url }`: the browser
+ *   POSTs the values to that URL.
+ * - `{ via: "client", url }` — same, written out.
+ * - `{ via: "client", handler }` — the browser runs your own submit logic.
+ * - `{ via: "backend", destination }` — the browser relays the values to the backend,
+ *   which forwards them to the server-configured destination (URL + secret stay server-side).
+ * - `false` — collect only, no submit function.
+ */
+declare type SubmitConfig<V = Record<string, unknown>> = string | {
+    via: "client";
+    url: string;
+} | {
+    via: "client";
+    handler: (values: V) => Promise<unknown> | unknown;
+} | {
+    via: "backend";
+    destination: string;
+} | false;
+
 /**
  * Tool call data from SSE stream
  */

package/dist/devtools.d.ts

@@ -53,6 +53,13 @@ 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.
      *
@@ -399,6 +406,30 @@ export declare interface DevPanelOptions {
  */
 declare type DynamicContextProvider = () => ContextEntry | null | undefined;
 
+/**
+ * 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).
+ */
+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>;
+}
+
+/**
+ * Shape of a form's fields. Mirrors a client function's `parameters` (so the same
+ * object feeds the store, the update function, and the dynamic context). Additionally allows the SDK-only per-field `requiredWhen`, which {@link toWireParameters} removes before the schema reaches the LLM.
+ */
+declare interface FormCollectorSchema {
+    type: "object";
+    properties: Record<string, FormFieldSchema>;
+    required?: string[];
+}
+
 declare interface FormField {
     type: "string" | "number" | "boolean" | "array";
     title?: string;
@@ -407,6 +438,43 @@ declare interface FormField {
     default?: unknown;
 }
 
+/**
+ * A field's conditional-requiredness rule. The field becomes required exactly
+ * when the controlling `property` matches `value` against the answers collected
+ * so far:
+ * - a single `value`, no `op` — equality (compared as strings);
+ * - a single `value` with `op` — numeric comparison (both sides coerced to numbers);
+ * - an array `value`, no `op` — "one of": matches when the property equals any
+ *   listed value.
+ *
+ * SDK-only — it is stripped from the schema before it reaches the LLM tool
+ */
+declare interface FormFieldCondition {
+    /** The controlling field whose value the rule tests. */
+    property: string;
+    /** Comparison operator; omitted means equality. Ignored when `value` is an array. */
+    op?: ">=" | "<=" | ">" | "<";
+    /**
+     * The value(s) to test the controlling field against. A single value is an
+     * equality (or, with `op`, a numeric comparison); an array is an "is one of"
+     * membership test, e.g. `value: ["1", "2", "3"]`.
+     */
+    value: string | number | Array<string | number>;
+}
+
+/** A single field's schema: the wire-legal keys plus the SDK-only `requiredWhen`. */
+declare interface FormFieldSchema {
+    type: string;
+    description?: string;
+    enum?: string[];
+    default?: unknown;
+    /**
+     * Makes the field required only while this condition holds. Drives the dynamic
+     * `missing` list; stripped before the LLM tool — see {@link toWireParameters}.
+     */
+    requiredWhen?: FormFieldCondition;
+}
+
 /**
  * Form schema for tool calls requiring user input
  */
@@ -432,6 +500,27 @@ declare interface SendMessageOptions {
     files?: File[];
 }
 
+/**
+ * Where a completed form is sent.
+ * - `"https://..."` (a bare string) — shorthand for `{ via: "client", url }`: the browser
+ *   POSTs the values to that URL.
+ * - `{ via: "client", url }` — same, written out.
+ * - `{ via: "client", handler }` — the browser runs your own submit logic.
+ * - `{ via: "backend", destination }` — the browser relays the values to the backend,
+ *   which forwards them to the server-configured destination (URL + secret stay server-side).
+ * - `false` — collect only, no submit function.
+ */
+declare type SubmitConfig<V = Record<string, unknown>> = string | {
+    via: "client";
+    url: string;
+} | {
+    via: "client";
+    handler: (values: V) => Promise<unknown> | unknown;
+} | {
+    via: "backend";
+    destination: string;
+} | false;
+
 /**
  * Tool call data from SSE stream
  */

package/dist/index.cjs

@@ -1 +1 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i=require("./AgoClient-CPqPT5s6.cjs"),m=require("./createFormCollector-DaWZsBsI.cjs"),A=require("./createConversationSession-CGRO0bs2.cjs"),C=require("./createMockClient-zHQ0cjUH.cjs");require("./testing.cjs");const g=require("./functions-DsmzgHjC.cjs");function h(e){return e}function E(e,o){return e.on("message:complete",o),()=>e.off("message:complete",o)}function S(e,o){return e.on("message:chunk",o),()=>e.off("message:chunk",o)}function y(e,o){return e.on("message:start",o),()=>e.off("message:start",o)}function b(e,o){return e.on("message:error",o),()=>e.off("message:error",o)}function v(e,o){return e.on("toolCall:received",o),()=>e.off("toolCall:received",o)}function M(e,o){return e.on("function:invoke",o),()=>e.off("function:invoke",o)}async function*k(e,o,l){const n=[];let r=null,a=!1;const c=s=>{n.push(s),r?.()},f=s=>c({type:"start",data:s}),t=s=>c({type:"chunk",data:s}),u=s=>{c({type:"complete",data:s}),a=!0,r?.()},d=s=>{c({type:"error",data:s}),a=!0,r?.()},p=s=>c({type:"toolCall",data:s});e.on("message:start",f),e.on("message:chunk",t),e.on("message:complete",u),e.on("message:error",d),e.on("toolCall:received",p),e.sendMessage(o,l).catch(()=>{a=!0,r?.()});try{for(;!a||n.length>0;)n.length>0?yield n.shift():(await new Promise(s=>{r=s}),r=null)}finally{e.off("message:start",f),e.off("message:chunk",t),e.off("message:complete",u),e.off("message:error",d),e.off("toolCall:received",p)}}function w(e){let o,l,n,r,a,c;if(typeof window<"u"&&window.AGO){const t=window.AGO;o=t.basepath,l=t.widgetId,n=t.agent||t.defaultAgent,r=t.permission,a=t.email,c=t.jwt}if(typeof document<"u"){const t=u=>document.querySelector(`meta[name="${u}"]`)?.getAttribute("content")||void 0;o=o||t("ago-base-url"),l=l||t("ago-widget-id"),n=n||t("ago-agent")||t("ago-agent-id"),r=r||t("ago-permission"),a=a||t("ago-user-email")}if(typeof document<"u"){const t=[document.body,...Array.from(document.querySelectorAll("script[data-ago-base-url]"))].filter(Boolean);for(const u of t)u&&(o=o||u.getAttribute("data-ago-base-url")||void 0,l=l||u.getAttribute("data-ago-widget-id")||void 0,n=n||u.getAttribute("data-ago-agent")||u.getAttribute("data-ago-agent-id")||void 0,r=r||u.getAttribute("data-ago-permission")||void 0,a=a||u.getAttribute("data-ago-user-email")||void 0)}o=e?.baseUrl||o,l=e?.widgetId||l,n=e?.agent||e?.defaultAgentId||n,r=e?.permission||r,a=e?.userEmail||a,c=e?.userJwt||c;const f=e?.debug;return o?{baseUrl:o,widgetId:l,agent:n,permission:r,userEmail:a,userJwt:c,debug:f}:null}function F(e){const o=w(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 i.AgoClient(o)}function q(e,o){return{...e,handler:o}}exports.AgoApiError=i.AgoApiError;exports.AgoClient=i.AgoClient;exports.AgoError=i.AgoError;exports.AgoFunctionError=i.AgoFunctionError;exports.AgoNetworkError=i.AgoNetworkError;exports.AgoStreamError=i.AgoStreamError;exports.ClientContextRegistry=i.ClientContextRegistry;exports.EventEmitter=i.EventEmitter;exports.FunctionRegistry=i.FunctionRegistry;exports.SSEHandler=i.SSEHandler;exports.autoDetectConfig=w;exports.copyToClipboard=g.copyToClipboard;exports.createAgo=F;exports.createConversationSession=A.createConversationSession;exports.createFormCollector=m.createFormCollector;exports.createMessageStream=k;exports.createMockClient=C.createMockClient;exports.createStore=m.createStore;exports.defineFunction=h;exports.deriveFormStatus=m.deriveFormStatus;exports.getLocalStorage=g.getLocalStorage;exports.getUserLocation=g.getUserLocation;exports.highlightElement=g.highlightElement;exports.isStreamNetworkError=i.isStreamNetworkError;exports.logger=i.logger;exports.onFunctionInvoke=M;exports.onMessage=E;exports.onMessageChunk=S;exports.onMessageError=b;exports.onMessageStart=y;exports.onToolCall=v;exports.openUrl=g.openUrl;exports.scrollToElement=g.scrollToElement;exports.setLocalStorage=g.setLocalStorage;exports.setTheme=g.setTheme;exports.showConfirmDialog=g.showConfirmDialog;exports.showNotification=g.showNotification;exports.showToast=g.showToast;exports.submitForm=g.submitForm;exports.trackEvent=g.trackEvent;exports.withHandler=q;
+Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i=require("./AgoClient-0x2Du_62.cjs"),f=require("./createFormCollector-Ca8wRrxc.cjs"),w=require("./createConversationSession-BLZvXMmM.cjs"),A=require("./createMockClient-zHQ0cjUH.cjs");require("./testing.cjs");const g=require("./functions-DsmzgHjC.cjs");function h(e){return e}function E(e,o){return e.on("message:complete",o),()=>e.off("message:complete",o)}function S(e,o){return e.on("message:chunk",o),()=>e.off("message:chunk",o)}function y(e,o){return e.on("message:start",o),()=>e.off("message:start",o)}function b(e,o){return e.on("message:error",o),()=>e.off("message:error",o)}function v(e,o){return e.on("toolCall:received",o),()=>e.off("toolCall:received",o)}function F(e,o){return e.on("function:invoke",o),()=>e.off("function:invoke",o)}async function*M(e,o,l){const n=[];let r=null,a=!1;const c=s=>{n.push(s),r?.()},m=s=>c({type:"start",data:s}),t=s=>c({type:"chunk",data:s}),u=s=>{c({type:"complete",data:s}),a=!0,r?.()},d=s=>{c({type:"error",data:s}),a=!0,r?.()},C=s=>c({type:"toolCall",data:s});e.on("message:start",m),e.on("message:chunk",t),e.on("message:complete",u),e.on("message:error",d),e.on("toolCall:received",C),e.sendMessage(o,l).catch(()=>{a=!0,r?.()});try{for(;!a||n.length>0;)n.length>0?yield n.shift():(await new Promise(s=>{r=s}),r=null)}finally{e.off("message:start",m),e.off("message:chunk",t),e.off("message:complete",u),e.off("message:error",d),e.off("toolCall:received",C)}}function p(e){let o,l,n,r,a,c;if(typeof window<"u"&&window.AGO){const t=window.AGO;o=t.basepath,l=t.widgetId,n=t.agent||t.defaultAgent,r=t.permission,a=t.email,c=t.jwt}if(typeof document<"u"){const t=u=>document.querySelector(`meta[name="${u}"]`)?.getAttribute("content")||void 0;o=o||t("ago-base-url"),l=l||t("ago-widget-id"),n=n||t("ago-agent")||t("ago-agent-id"),r=r||t("ago-permission"),a=a||t("ago-user-email")}if(typeof document<"u"){const t=[document.body,...Array.from(document.querySelectorAll("script[data-ago-base-url]"))].filter(Boolean);for(const u of t)u&&(o=o||u.getAttribute("data-ago-base-url")||void 0,l=l||u.getAttribute("data-ago-widget-id")||void 0,n=n||u.getAttribute("data-ago-agent")||u.getAttribute("data-ago-agent-id")||void 0,r=r||u.getAttribute("data-ago-permission")||void 0,a=a||u.getAttribute("data-ago-user-email")||void 0)}o=e?.baseUrl||o,l=e?.widgetId||l,n=e?.agent||e?.defaultAgentId||n,r=e?.permission||r,a=e?.userEmail||a,c=e?.userJwt||c;const m=e?.debug;return o?{baseUrl:o,widgetId:l,agent:n,permission:r,userEmail:a,userJwt:c,debug:m}:null}function k(e){const o=p(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 i.AgoClient(o)}function q(e,o){return{...e,handler:o}}exports.AgoApiError=i.AgoApiError;exports.AgoClient=i.AgoClient;exports.AgoError=i.AgoError;exports.AgoFunctionError=i.AgoFunctionError;exports.AgoNetworkError=i.AgoNetworkError;exports.AgoStreamError=i.AgoStreamError;exports.ClientContextRegistry=i.ClientContextRegistry;exports.EventEmitter=i.EventEmitter;exports.FunctionRegistry=i.FunctionRegistry;exports.SSEHandler=i.SSEHandler;exports.autoDetectConfig=p;exports.copyToClipboard=g.copyToClipboard;exports.createAgo=k;exports.createConversationSession=w.createConversationSession;exports.createFormCollector=f.createFormCollector;exports.createMessageStream=M;exports.createMockClient=A.createMockClient;exports.createStore=f.createStore;exports.defineFunction=h;exports.deriveFormStatus=f.deriveFormStatus;exports.getLocalStorage=g.getLocalStorage;exports.getUserLocation=g.getUserLocation;exports.highlightElement=g.highlightElement;exports.isStreamNetworkError=i.isStreamNetworkError;exports.loadFormCollector=f.loadFormCollector;exports.logger=i.logger;exports.onFunctionInvoke=F;exports.onMessage=E;exports.onMessageChunk=S;exports.onMessageError=b;exports.onMessageStart=y;exports.onToolCall=v;exports.openUrl=g.openUrl;exports.scrollToElement=g.scrollToElement;exports.setLocalStorage=g.setLocalStorage;exports.setTheme=g.setTheme;exports.showConfirmDialog=g.showConfirmDialog;exports.showNotification=g.showNotification;exports.showToast=g.showToast;exports.submitForm=g.submitForm;exports.trackEvent=g.trackEvent;exports.withHandler=q;