@useago/sdk 0.4.4 → 0.4.5

package/dist/widget.d.ts

@@ -516,11 +516,14 @@ export declare interface CreateFormCollectorOptions<V = Record<string, unknown>>
 declare type DynamicContextProvider = () => ContextEntry | null | undefined;
 
 /**
- * JSON-schema shape of a form's fields — identical to a client function's
- * `parameters`, so one schema feeds the store, the update function, and the
- * dynamic context with no second type.
+ * 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 type FormCollectorSchema = ClientFunctionSchema["parameters"];
+declare interface FormCollectorSchema {
+    type: "object";
+    properties: Record<string, FormFieldSchema>;
+    required?: string[];
+}
 
 declare interface FormField {
     type: "string" | "number" | "boolean" | "array";
@@ -530,6 +533,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
  */

package/dist/widget.js

@@ -1,6 +1,6 @@
 import { t as ge } from "./AgoClient-rvTz2thR.js";
-import { t as ue } from "./createFormCollector-D4-yZh1i.js";
-import { t as xe } from "./createConversationSession-XkiOGAUT.js";
+import { t as ue } from "./createFormCollector-Cujr7hW4.js";
+import { t as xe } from "./createConversationSession-DbuVzvoX.js";
 var oe = 'var(--ago-font, "IBM Plex Sans", -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif)', Z = {
   font: "--ago-font",
   radius: "--ago-radius",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@useago/sdk",
-  "version": "0.4.4",
+  "version": "0.4.5",
   "description": "JavaScript SDK for AGO Chat integration",
   "type": "module",
   "sideEffects": false,

package/dist/createFormCollector-D4-yZh1i.js

@@ -1,207 +0,0 @@
-import { s as E } from "./AgoClient-rvTz2thR.js";
-function T(i, r) {
-  const f = r ? r.storage ?? (typeof localStorage < "u" ? localStorage : void 0) : void 0;
-  let a = i;
-  if (r && f) try {
-    const u = f.getItem(r.key);
-    u != null && (a = JSON.parse(u));
-  } catch {
-  }
-  const l = /* @__PURE__ */ new Set(), g = () => l.forEach((u) => u(a));
-  function d() {
-    if (r && f) try {
-      f.setItem(r.key, JSON.stringify(a));
-    } catch {
-    }
-  }
-  return {
-    get: () => a,
-    set: (u) => {
-      a = u, d(), g();
-    },
-    subscribe: (u) => (l.add(u), () => {
-      l.delete(u);
-    })
-  };
-}
-var k = /^[a-zA-Z0-9_-]{1,40}$/, I = (i) => i == null || i === "";
-function y(i, r) {
-  const f = (i.required ?? []).filter((a) => I(r[a]));
-  return {
-    missing: f,
-    complete: f.length === 0
-  };
-}
-function q(i) {
-  const { name: r, description: f, schema: a } = i;
-  if (!k.test(r)) throw new Error(`Invalid form collector name "${r}": must match ${k} (it becomes the update_/submit_ function names).`);
-  const l = typeof i.submit == "string" ? i.submit ? {
-    via: "client",
-    url: i.submit
-  } : !1 : i.submit ?? !1, g = a.properties ?? {}, d = (e) => {
-    const t = {};
-    for (const [o, s] of Object.entries(e)) {
-      const n = g[o];
-      if (n)
-        if (s == null) t[o] = s;
-        else if (n.type === "number" || n.type === "integer") {
-          const m = typeof s == "number" ? s : Number(s);
-          t[o] = Number.isNaN(m) ? s : m;
-        } else n.type === "boolean" ? t[o] = typeof s == "boolean" ? s : s === "true" ? !0 : s === "false" ? !1 : !!s : t[o] = s;
-    }
-    return t;
-  }, u = i.initialValues ?? {}, c = T({
-    values: u,
-    submitted: !1
-  }), v = (e) => {
-    const t = c.get(), o = {
-      ...t,
-      values: {
-        ...t.values,
-        ...e
-      }
-    };
-    return c.set(o), o;
-  };
-  let b = null;
-  const C = async () => {
-    const { values: e } = c.get(), { complete: t, missing: o } = y(a, e);
-    if (!t) return {
-      ok: !1,
-      missing: o
-    };
-    if (!l) return {
-      ok: !1,
-      error: "No submit target configured for this form collector."
-    };
-    const s = e;
-    try {
-      let n;
-      if (l.via === "client") if ("handler" in l) n = await l.handler(s);
-      else {
-        const m = await fetch(l.url, {
-          method: "POST",
-          headers: { "Content-Type": "application/json" },
-          credentials: "include",
-          body: JSON.stringify(s)
-        });
-        if (!m.ok) return {
-          ok: !1,
-          error: `Submit failed: HTTP ${m.status}`
-        };
-        n = await m.json().catch(() => {
-        });
-      }
-      else {
-        if (!b) return {
-          ok: !1,
-          error: "Backend submit requires install(client) (or useFormCollector) first."
-        };
-        n = await b.submitFormCollector(l.destination, s);
-      }
-      return c.set({
-        ...c.get(),
-        submitted: !0
-      }), {
-        ok: !0,
-        result: n
-      };
-    } catch (n) {
-      const m = n instanceof Error ? n.message : "Submit failed";
-      return E.error(`FormCollector "${r}" submit failed:`, n), {
-        ok: !1,
-        error: m
-      };
-    }
-  }, N = {
-    name: `update_${r}`,
-    description: `Fill or update fields of the "${r}" form. ${f} 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: {
-      ...a,
-      required: []
-    },
-    handler: (e) => {
-      const t = v(d(e)), { missing: o } = y(a, t.values);
-      return {
-        ok: !0,
-        values: t.values,
-        missing: o
-      };
-    }
-  }, h = [N];
-  l && h.push({
-    name: `submit_${r}`,
-    description: `Submit the completed "${r}" 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: () => C()
-  });
-  const _ = "client__", $ = l ? `submit_${r}` : null, x = (e) => {
-    const t = e.functionName ?? e.toolName;
-    if (t)
-      return t.startsWith(_) ? t.slice(8) : t;
-  }, w = (e) => {
-    let t = { ...u }, o = !1;
-    for (const s of e) {
-      const n = x(s);
-      n === N.name ? s.arguments && (t = {
-        ...t,
-        ...d(s.arguments)
-      }) : $ && n === $ && s.status?.toLowerCase() === "done" && (o = !0);
-    }
-    c.set({
-      values: t,
-      submitted: o
-    });
-  }, p = `form:${r}`, F = () => {
-    const { values: e, submitted: t } = c.get(), { missing: o } = y(a, e), s = l ? ` When nothing is missing and the user confirms, call submit_${r}.` : "";
-    return {
-      name: `Form: ${r}`,
-      description: `Form being filled conversationally. ${f} Call update_${r} with any fields the user provides; ask only for what is still missing.${s}`,
-      data: {
-        values: e,
-        missing: o,
-        submitted: t
-      }
-    };
-  }, S = (e) => {
-    w((e.messages ?? []).flatMap((t) => t.toolCalls ?? []));
-  };
-  return {
-    name: r,
-    store: c,
-    functions: h,
-    contextKey: p,
-    contextProvider: F,
-    install: (e) => {
-      b = e;
-      for (const o of h) e.register(o);
-      e.addDynamicContext(p, F);
-      const t = c.subscribe(() => e.notifyContextChanged());
-      return e.on("conversation:loaded", S), () => {
-        t();
-        for (const o of h) e.unregisterFunction(o.name);
-        e.removeDynamicContext(p), e.off("conversation:loaded", S), b === e && (b = null);
-      };
-    },
-    hydrate: w,
-    submit: C,
-    getValues: () => c.get().values,
-    setValues: (e) => {
-      v(d(e));
-    },
-    reset: () => {
-      c.set({
-        values: u,
-        submitted: !1
-      });
-    }
-  };
-}
-export {
-  y as n,
-  T as r,
-  q as t
-};

package/dist/createFormCollector-DLwgDX24.cjs

@@ -1 +0,0 @@
-const E=require("./AgoClient-D4EL6nva.cjs");function k(i,s){const f=s?s.storage??(typeof localStorage<"u"?localStorage:void 0):void 0;let a=i;if(s&&f)try{const u=f.getItem(s.key);u!=null&&(a=JSON.parse(u))}catch{}const l=new Set,y=()=>l.forEach(u=>u(a));function d(){if(s&&f)try{f.setItem(s.key,JSON.stringify(a))}catch{}}return{get:()=>a,set:u=>{a=u,d(),y()},subscribe:u=>(l.add(u),()=>{l.delete(u)})}}var _=/^[a-zA-Z0-9_-]{1,40}$/,T=i=>i==null||i==="";function h(i,s){const f=(i.required??[]).filter(a=>T(s[a]));return{missing:f,complete:f.length===0}}function j(i){const{name:s,description:f,schema:a}=i;if(!_.test(s))throw new Error(`Invalid form collector name "${s}": must match ${_} (it becomes the update_/submit_ function names).`);const l=typeof i.submit=="string"?i.submit?{via:"client",url:i.submit}:!1:i.submit??!1,y=a.properties??{},d=e=>{const t={};for(const[n,r]of Object.entries(e)){const o=y[n];if(o)if(r==null)t[n]=r;else if(o.type==="number"||o.type==="integer"){const m=typeof r=="number"?r:Number(r);t[n]=Number.isNaN(m)?r:m}else o.type==="boolean"?t[n]=typeof r=="boolean"?r:r==="true"?!0:r==="false"?!1:!!r:t[n]=r}return t},u=i.initialValues??{},c=k({values:u,submitted:!1}),v=e=>{const t=c.get(),n={...t,values:{...t.values,...e}};return c.set(n),n};let b=null;const C=async()=>{const{values:e}=c.get(),{complete:t,missing:n}=h(a,e);if(!t)return{ok:!1,missing:n};if(!l)return{ok:!1,error:"No submit target configured for this form collector."};const r=e;try{let o;if(l.via==="client")if("handler"in l)o=await l.handler(r);else{const m=await fetch(l.url,{method:"POST",headers:{"Content-Type":"application/json"},credentials:"include",body:JSON.stringify(r)});if(!m.ok)return{ok:!1,error:`Submit failed: HTTP ${m.status}`};o=await m.json().catch(()=>{})}else{if(!b)return{ok:!1,error:"Backend submit requires install(client) (or useFormCollector) first."};o=await b.submitFormCollector(l.destination,r)}return c.set({...c.get(),submitted:!0}),{ok:!0,result:o}}catch(o){const m=o instanceof Error?o.message:"Submit failed";return E.logger.error(`FormCollector "${s}" submit failed:`,o),{ok:!1,error:m}}},N={name:`update_${s}`,description:`Fill or update fields of the "${s}" form. ${f} 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:{...a,required:[]},handler:e=>{const t=v(d(e)),{missing:n}=h(a,t.values);return{ok:!0,values:t.values,missing:n}}},g=[N];l&&g.push({name:`submit_${s}`,description:`Submit the completed "${s}" 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:()=>C()});const O="client__",$=l?`submit_${s}`:null,P=e=>{const t=e.functionName??e.toolName;if(t)return t.startsWith(O)?t.slice(8):t},F=e=>{let t={...u},n=!1;for(const r of e){const o=P(r);o===N.name?r.arguments&&(t={...t,...d(r.arguments)}):$&&o===$&&r.status?.toLowerCase()==="done"&&(n=!0)}c.set({values:t,submitted:n})},p=`form:${s}`,S=()=>{const{values:e,submitted:t}=c.get(),{missing:n}=h(a,e),r=l?` When nothing is missing and the user confirms, call submit_${s}.`:"";return{name:`Form: ${s}`,description:`Form being filled conversationally. ${f} Call update_${s} with any fields the user provides; ask only for what is still missing.${r}`,data:{values:e,missing:n,submitted:t}}},w=e=>{F((e.messages??[]).flatMap(t=>t.toolCalls??[]))};return{name:s,store:c,functions:g,contextKey:p,contextProvider:S,install:e=>{b=e;for(const n of g)e.register(n);e.addDynamicContext(p,S);const t=c.subscribe(()=>e.notifyContextChanged());return e.on("conversation:loaded",w),()=>{t();for(const n of g)e.unregisterFunction(n.name);e.removeDynamicContext(p),e.off("conversation:loaded",w),b===e&&(b=null)}},hydrate:F,submit:C,getValues:()=>c.get().values,setValues:e=>{v(d(e))},reset:()=>{c.set({values:u,submitted:!1})}}}Object.defineProperty(exports,"createFormCollector",{enumerable:!0,get:function(){return j}});Object.defineProperty(exports,"createStore",{enumerable:!0,get:function(){return k}});Object.defineProperty(exports,"deriveFormStatus",{enumerable:!0,get:function(){return h}});