@helpai/elements 0.23.0 → 0.25.0

package/web-component.mjs

@@ -19,7 +19,12 @@ var BRAND = {
   // and @goai builds.
   tagName: true ? "web-ai-chat" : "web-ai-chat",
   cssPrefix: true ? "helpai" : "helpai",
-  defaultBaseUrl: true ? "https://help.ai/api" : "",
+  /**
+   * MAIN site origin (e.g. `https://help.ai`) — module bases derive from it:
+   * agent API at `${defaultBaseUrl}/api/agent`, data API at
+   * `${defaultBaseUrl}/api/data`.
+   */
+  defaultBaseUrl: true ? "https://help.ai" : "",
   standaloneUrl: true ? "https://help.ai/chat" : "",
   /** Public-facing brand label, e.g. "Help AI" / "Go AI". */
   displayName: true ? "Help AI" : "Help AI",
@@ -457,13 +462,12 @@ var DEFAULT_FEATURES = {
 var DEFAULT_FORMS = { list: [], byTrigger: {} };
 var DEFAULT_TRACKING = {
   enabled: false,
-  endpoint: `https://t.${BRAND.domain}/api/ai-elements/px.gif`,
   sampleRate: 1
 };
 var DEFAULT_ENDPOINTS = {
   upload: "/ai/agent/upload-file",
   transcribe: "/ai/agent/transcribe-audio",
-  submitForm: "/ai/agent/submit-form"
+  submitForm: "/submit-form"
 };
 var DEFAULT_LAUNCHER = {
   variant: "circle",
@@ -505,11 +509,14 @@ function resolveOptions(rawOpts) {
   const mode = presentation.mode ?? "floating";
   const locale = i18n.locale ?? resolveDefaultLocale(i18n.defaultLocale);
   const availableLocales = i18n.availableLocales ?? [locale];
+  const baseUrl = (opts.baseUrl ?? BRAND.defaultBaseUrl).replace(/\/$/, "");
+  const dataBaseUrl = (opts.dataBaseUrl ?? `${baseUrl}/api/data`).replace(/\/$/, "");
   return {
     widgetId: opts.widgetId ?? "default",
     publicKey: opts.publicKey,
     aiAgentDeploymentId: opts.aiAgentDeploymentId,
-    baseUrl: (opts.baseUrl ?? BRAND.defaultBaseUrl).replace(/\/$/, ""),
+    baseUrl,
+    dataBaseUrl,
     userContext: sanitizeUserContext(opts.userContext),
     pageContext: sanitizePageContext(opts.pageContext),
     position: presentation.position ?? "bottom-right",
@@ -554,7 +561,7 @@ function resolveOptions(rawOpts) {
     poweredBy: resolvePoweredBy(footer.poweredBy),
     composer: resolveComposer(opts.composer),
     modules: resolveModules(opts.modules),
-    tracking: resolveTracking(opts.tracking),
+    tracking: resolveTracking(opts.tracking, dataBaseUrl),
     storage: opts.storage ?? defaultStorage,
     onMessage: opts.onMessage,
     onOpen: opts.onOpen,
@@ -587,11 +594,13 @@ function resolveHaptics(overrides) {
     events: overrides?.events
   };
 }
-function resolveTracking(overrides) {
+function resolveTracking(overrides, dataBaseUrl) {
   const sampleRate = overrides?.sampleRate ?? DEFAULT_TRACKING.sampleRate;
   return {
     enabled: overrides?.enabled ?? DEFAULT_TRACKING.enabled,
-    endpoint: overrides?.endpoint ?? DEFAULT_TRACKING.endpoint,
+    // The collector rides the data module — `${dataBaseUrl}/elements/px.gif`
+    // (e.g. `https://help.ai/api/data/elements/px.gif`).
+    endpoint: overrides?.endpoint ?? `${dataBaseUrl}/elements/px.gif`,
     // Clamp instead of reject — a malformed rate must never turn a
     // disabled tracker on or crash resolve (no Zod on the IIFE path).
     sampleRate: Math.min(1, Math.max(0, Number.isFinite(sampleRate) ? sampleRate : 1)),
@@ -665,7 +674,9 @@ function resolveForms(overrides) {
       submitLabel: def.submitLabel,
       skippable: def.skippable ?? false,
       frequency: def.frequency ?? "once",
-      mirrorToContext: def.mirrorToContext ?? true
+      mirrorToContext: def.mirrorToContext ?? true,
+      reopenable: def.reopenable ?? true,
+      reviewable: def.reviewable ?? true
     });
   }
   const byTrigger = {};
@@ -758,7 +769,7 @@ function mergeServerConfig(user, server) {
     out[key] = mergeLeaves(sv, uv);
   }
   if (server.modules !== void 0 && user.modules === void 0) out.modules = server.modules;
-  if (server.forms !== void 0 && user.forms === void 0) out.forms = server.forms;
+  if (server.dataBaseUrl !== void 0 && user.dataBaseUrl === void 0) out.dataBaseUrl = server.dataBaseUrl;
   const userI18n = user.i18n;
   const serverI18n = server.i18n;
   if (userI18n || serverI18n) {
@@ -818,6 +829,7 @@ var EMBED_SCALAR_ATTRS = [
   ["public-key", "publicKey"],
   ["ai-agent-deployment-id", "aiAgentDeploymentId"],
   ["base-url", "baseUrl"],
+  ["data-base-url", "dataBaseUrl"],
   ["theme", "theme", (v) => v]
 ];
 var PRESENTATION_ATTRS = [
@@ -1323,16 +1335,33 @@ var DEFAULT_PATHS = {
    * on the client; a failure just leaves the badge until the next sync.
    */
   markRead: "/ai/agent/mark-read",
-  // ── CMS content (unified — Home / Help / News / docs) ─────────────
-  /** All widget content via one filtered endpoint. `GET /ai/agent/content?tags=…`. */
-  content: "/ai/agent/content",
+  // ── Data API (module-help-ai-data-api, via `dataBaseUrl`) ─────────
+  /** All widget content via one filtered endpoint. `GET /content?tags=…`. */
+  content: "/content",
+  /**
+   * Resolved form definitions for the deployment. `GET /forms` →
+   * `{ forms: FormDef[] }`. Fetched once at boot (in parallel with
+   * start-conversation); form gating waits for it. A failure is treated as
+   * "no forms" (non-fatal).
+   */
+  forms: "/forms",
   /**
    * Form submission (the event-driven forms engine). POST `{ visitorId,
    * conversationId, formId, trigger, values, skipped? }` → record the form's answers
    * immediately, keyed by the same `visitorId` + `conversationId` the chat uses.
    * Overridable via `endpoints.submitForm`. Fire-and-forget; 404 is ignored.
    */
-  submitForm: "/ai/agent/submit-form"
+  submitForm: "/submit-form",
+  /**
+   * Visitor interaction records for a conversation. `GET
+   * /activity?visitorId=…&conversationId=…` →
+   * `{ formSubmissions: FormSubmissionRecord[] }` (chronological). Replaces
+   * the former `formSubmissions` echo on start-conversation / list-messages;
+   * deliberately generic — future visitor interaction records ride the same
+   * endpoint. A failure (e.g. 404 `AI_AGENT_PUBLIC_ACCESS_NOT_FOUND` when the
+   * deployment doesn't resolve) is treated as "no records" (non-fatal).
+   */
+  activity: "/activity"
 };
 var CONTEXT_PARAM = "context";
 function buildSendMessageRequest(params) {
@@ -1605,14 +1634,17 @@ var AgentTransport = class {
       log4.debug("markRead failed (non-fatal)", { err });
     }
   }
-  // ---- CMS content (unified) --------------------------------------------
+  // ---- Data API (content / forms — module-help-ai-data-api) --------------
   //
-  // One endpoint for every content surface (Home / Help / News / docs).
-  // Callers pass filters; a thrown StreamError (e.g. 404 on an older backend)
-  // is treated as "no content" by the module and the tab degrades gracefully.
-  /** Fetch content rows by filter. `GET /ai/agent/content`. */
+  // The DATA surfaces live on `dataBaseUrl` (default `${baseUrl}/api/data`)
+  // with ROOT-level paths — same auth headers + envelope, same retry
+  // behavior. One endpoint for every content surface (Home / Help / News /
+  // docs); callers pass filters; a thrown StreamError (e.g. 404 on an older
+  // backend) is treated as "no content" by the module and the tab degrades
+  // gracefully.
+  /** Fetch content rows by filter. `GET /content` (data-API). */
   async listContent(query = {}) {
-    const url = new URL(this.url(DEFAULT_PATHS.content));
+    const url = new URL(this.dataUrl(DEFAULT_PATHS.content));
     for (const [key, value] of Object.entries(query)) {
       if (value === void 0) continue;
       url.searchParams.set(key, Array.isArray(value) ? value.join(",") : String(value));
@@ -1623,6 +1655,40 @@ var AgentTransport = class {
     log4.debug("listContent \u2190", { count: items.length, total: res.pagination?.total });
     return { ...res, items };
   }
+  /**
+   * Fetch the deployment's resolved form definitions. `GET /forms`
+   * (data-API). Replaces the former `config.forms` push on the handshake —
+   * called once at boot, in parallel with `startConversation`; form gating
+   * (pre-chat etc.) waits for it. Callers treat a thrown StreamError as
+   * "no forms" (non-fatal).
+   */
+  async listForms() {
+    log4.debug("listForms \u2192");
+    const res = await this.getJson(this.dataUrl(DEFAULT_PATHS.forms), "listForms");
+    const forms = res.forms ?? [];
+    log4.debug("listForms \u2190", { count: forms.length });
+    return { forms };
+  }
+  /**
+   * Fetch the visitor's recorded activity for a conversation — currently the
+   * form submissions that rebuild the collapsed "form submitted / skipped"
+   * timeline markers on resume. `GET /activity` (data-API); the
+   * envelope carries `visitorId` / `conversationId` as query params.
+   * `conversationId` here is an optional resource selector (a thread that may
+   * differ from the active conversation — the history-pane switch); when
+   * omitted, the envelope's active conversation applies. Callers treat a
+   * thrown StreamError (e.g. 404 on a deployment that doesn't resolve) as
+   * "no activity" (non-fatal).
+   */
+  async getActivity(conversationId) {
+    const url = new URL(this.dataUrl(DEFAULT_PATHS.activity));
+    if (conversationId) url.searchParams.set("conversationId", conversationId);
+    log4.debug("getActivity \u2192", { conversationId: conversationId ?? this.conversationId });
+    const res = await this.getJson(url.toString(), "getActivity");
+    const formSubmissions = res.formSubmissions ?? [];
+    log4.debug("getActivity \u2190", { count: formSubmissions.length });
+    return { formSubmissions };
+  }
   async saveUserPrefs(userPrefs) {
     log4.debug("saveUserPrefs \u2192", {
       visitorId: this.visitorId,
@@ -1643,8 +1709,9 @@ var AgentTransport = class {
     return this.opts.endpoints?.submitForm ?? DEFAULT_PATHS.submitForm;
   }
   /**
-   * Record a completed form (intake, CSAT, claim, …). Fire-and-forget — the
-   * record is captured even if the visitor never sends a message. `conversationId`,
+   * Record a completed form (intake, CSAT, claim, …). `POST
+   * /submit-form` (data-API). Fire-and-forget — the record is
+   * captured even if the visitor never sends a message. `conversationId`,
    * `formId`, and `trigger` are explicit so the backend can tie + route;
    * `visitorId` + context ride the envelope. A failure (e.g. 404 on a backend
    * that doesn't implement the endpoint) is non-fatal, so callers don't await.
@@ -1652,7 +1719,7 @@ var AgentTransport = class {
   async submitForm(body) {
     log4.debug("submitForm \u2192", { formId: body.formId, trigger: body.trigger, fields: Object.keys(body.values).length });
     try {
-      await this.postJson(this.submitFormPath, body, "submitForm");
+      await this.postJson(this.dataUrl(this.submitFormPath), body, "submitForm");
     } catch (err) {
       log4.debug("submitForm failed (non-fatal)", { err });
     }
@@ -1888,9 +1955,24 @@ var AgentTransport = class {
     if (!res.ok) throw new StreamError(`${label} failed: ${res.status}`, "server", res.status);
     return await res.json();
   }
+  /**
+   * Agent-API URL — resolves a `/ai/agent/*` path against the agent module
+   * base, `${baseUrl}/api/agent`. Absolute URLs pass through unchanged.
+   */
   url(pathOrUrl) {
     if (/^https?:\/\//i.test(pathOrUrl)) return pathOrUrl;
-    return `${this.opts.baseUrl}${pathOrUrl}`;
+    return `${this.opts.baseUrl}/api/agent${pathOrUrl}`;
+  }
+  /**
+   * Data-API variant of {@link url} — resolves a root-level path (content /
+   * forms / submit-form / activity) against `dataBaseUrl`. Absolute URLs
+   * (e.g. an `endpoints.submitForm` pointing straight at a CRM) pass through
+   * unchanged; with no `dataBaseUrl` configured the data module derives from
+   * the main origin: `${baseUrl}/api/data`.
+   */
+  dataUrl(pathOrUrl) {
+    if (/^https?:\/\//i.test(pathOrUrl)) return pathOrUrl;
+    return `${this.opts.dataBaseUrl ?? `${this.opts.baseUrl}/api/data`}${pathOrUrl}`;
   }
   get fetchImpl() {
     return this.opts.fetchImpl ?? globalThis.fetch.bind(globalThis);
@@ -4357,7 +4439,8 @@ function FormDoneMarker({
     "\xB7 ",
     marker.title
   ] }) : null;
-  const values = !skipped && marker.values && Object.keys(marker.values).length > 0 ? marker.values : null;
+  const reviewable = marker.form?.reviewable ?? false;
+  const values = !skipped && reviewable && marker.values && Object.keys(marker.values).length > 0 ? marker.values : null;
   if (values) {
     const labelFor = (name) => marker.form?.fields.find((f) => f.name === name)?.label ?? name;
     return /* @__PURE__ */ jsxs9("details", { class: `${p11}-form-done`, "data-outcome": marker.outcome, "data-testid": TID.formDone, children: [
@@ -4377,7 +4460,7 @@ function FormDoneMarker({
     skipped ? /* @__PURE__ */ jsx11(SkipIcon, {}) : /* @__PURE__ */ jsx11(CheckIcon, {}),
     /* @__PURE__ */ jsx11("span", { children: skipped ? strings.formSkipped : strings.formSubmitted }),
     title,
-    skipped && marker.form && onFill ? /* @__PURE__ */ jsx11("button", { type: "button", class: `${p11}-form-done-fill`, "data-testid": TID.formFill, onClick: onFill, children: strings.formFillOut }) : null
+    skipped && marker.form?.reopenable && onFill ? /* @__PURE__ */ jsx11("button", { type: "button", class: `${p11}-form-done-fill`, "data-testid": TID.formFill, onClick: onFill, children: strings.formFillOut }) : null
   ] });
 }
 
@@ -6414,6 +6497,8 @@ function App({ options, hostElement, bus }) {
   const chatTabIdRef = useRef9(void 0);
   chatTabIdRef.current = chatTabId();
   const [conversationReady, setConversationReady] = useState13(false);
+  const [remoteForms, setRemoteForms] = useState13(null);
+  const [formsReady, setFormsReady] = useState13(false);
   const isInlineLike = options.mode === "standalone" || options.mode === "inline";
   const initialPanelRef = useRef9(
     resolveInitialPanelState(options, currentViewportWidth(), persistence.loadPanelOpen(), persistence.loadPanelSize())
@@ -6446,6 +6531,7 @@ function App({ options, hostElement, bus }) {
   const [transport] = useState13(
     () => new AgentTransport({
       baseUrl: options.baseUrl,
+      dataBaseUrl: options.dataBaseUrl,
       auth: createAuth({
         publicKey: options.publicKey,
         aiAgentDeploymentId: options.aiAgentDeploymentId,
@@ -6526,6 +6612,26 @@ function App({ options, hostElement, bus }) {
     },
     [messagesSig]
   );
+  const fetchFormMarkers = useCallback6(
+    async (conversationId) => {
+      try {
+        const { formSubmissions: subs } = await transport.getActivity(conversationId);
+        const lastIndexByForm = /* @__PURE__ */ new Map();
+        subs.forEach((rec, i) => lastIndexByForm.set(rec.formId, i));
+        return subs.filter((rec, i) => !rec.skipped || lastIndexByForm.get(rec.formId) === i).map((rec, i) => ({
+          key: `wire:${rec.formId}:${rec.createdAt ?? i}`,
+          formId: rec.formId,
+          outcome: rec.skipped ? "skipped" : "submitted",
+          createdAt: parseWireDate(rec.createdAt),
+          values: rec.values
+        }));
+      } catch (err) {
+        log16.debug("getActivity failed \u2014 no form markers (non-fatal)", { err });
+        return [];
+      }
+    },
+    [transport]
+  );
   const connectGenRef = useRef9(0);
   const runStartConversation = useCallback6(
     async ({ newConversation }) => {
@@ -6594,24 +6700,14 @@ function App({ options, hostElement, bus }) {
       if (isResume) {
         setLoadingMessages(true);
         try {
-          const chat = res.messages?.length ? {
+          const chatPromise = res.messages?.length ? Promise.resolve({
             conversationId: persistedChatId,
             canContinue: res.canContinue ?? true,
-            messages: res.messages,
-            formSubmissions: res.formSubmissions
-          } : await transport.loadConversation(persistedChatId);
+            messages: res.messages
+          }) : transport.loadConversation(persistedChatId);
+          const [chat, markers] = await Promise.all([chatPromise, fetchFormMarkers()]);
           if (isStale()) return;
           const loaded = (chat.messages ?? []).map(fromWireMessage);
-          const subs = chat.formSubmissions ?? res.formSubmissions ?? [];
-          const lastIndexByForm = /* @__PURE__ */ new Map();
-          subs.forEach((rec, i) => lastIndexByForm.set(rec.formId, i));
-          const markers = subs.filter((rec, i) => !rec.skipped || lastIndexByForm.get(rec.formId) === i).map((rec, i) => ({
-            key: `wire:${rec.formId}:${rec.createdAt ?? i}`,
-            formId: rec.formId,
-            outcome: rec.skipped ? "skipped" : "submitted",
-            createdAt: parseWireDate(rec.createdAt),
-            values: rec.values
-          }));
           setFormMarkers(markers);
           const timelineStamps = [...loaded.map((m) => m.createdAt), ...markers.map((m) => m.createdAt)].filter(
             (n) => n !== void 0
@@ -6649,7 +6745,18 @@ function App({ options, hostElement, bus }) {
         setConversationReady(true);
       }
     },
-    [transport, visitorId, persistence, options, bus, messagesSig, conversationIdSig, feedback, playWelcome]
+    [
+      transport,
+      visitorId,
+      persistence,
+      options,
+      bus,
+      messagesSig,
+      conversationIdSig,
+      feedback,
+      playWelcome,
+      fetchFormMarkers
+    ]
   );
   const userSig = JSON.stringify(options.userContext ?? null);
   const pageSig = JSON.stringify(options.pageContext ?? null);
@@ -6704,6 +6811,16 @@ function App({ options, hostElement, bus }) {
   );
   useEffect17(() => {
     void runStartConversation({ newConversation: false });
+    void (async () => {
+      try {
+        const res = await transport.listForms();
+        setRemoteForms(resolveForms(res.forms));
+      } catch (err) {
+        log16.debug("listForms failed \u2014 treating as no forms", { err });
+      } finally {
+        setFormsReady(true);
+      }
+    })();
     const persistedConversation = conversationIdSig.value;
     let resume = null;
     if (persistedConversation) {
@@ -6840,8 +6957,9 @@ function App({ options, hostElement, bus }) {
     [options.features.humanInLoop, handleToolResult, handleToolDecision]
   );
   const userMessageCount = () => messagesSig.value.reduce((n, m) => n + (m.role === "user" ? 1 : 0), 0);
+  const effectiveForms = options.forms.list.length > 0 ? options.forms : remoteForms ?? options.forms;
   const forms = useForms({
-    forms: options.forms,
+    forms: effectiveForms,
     persistence,
     userContext: () => options.userContext,
     messageCount: userMessageCount,
@@ -6874,18 +6992,18 @@ function App({ options, hostElement, bus }) {
   const pageArea = options.pageContext?.area ? String(options.pageContext.area) : void 0;
   const msgCount = useComputed7(() => messagesSig.value.length);
   useEffect17(() => {
-    if (conversationReady) forms.fire("pre-chat");
-  }, [conversationReady, forms]);
+    if (conversationReady && formsReady) forms.fire("pre-chat");
+  }, [conversationReady, formsReady, forms]);
   useEffect17(() => {
-    if (!canSend) forms.fire("conversation-closed");
-  }, [canSend, forms]);
+    if (formsReady && !canSend) forms.fire("conversation-closed");
+  }, [formsReady, canSend, forms]);
   useEffect17(() => {
-    if (conversationReady && pageArea) forms.fire("page-area");
-  }, [conversationReady, pageArea, forms]);
+    if (conversationReady && formsReady && pageArea) forms.fire("page-area");
+  }, [conversationReady, formsReady, pageArea, forms]);
   const idleMs = useMemo3(() => {
-    const secs = options.forms.list.flatMap((f) => f.triggers).filter((t) => t.kind === "idle").map((t) => Number(t.param));
+    const secs = effectiveForms.list.flatMap((f) => f.triggers).filter((t) => t.kind === "idle").map((t) => Number(t.param));
     return secs.length ? Math.min(...secs) * 1e3 : 0;
-  }, [options.forms]);
+  }, [effectiveForms]);
   useEffect17(() => {
     if (!idleMs || !isOpen) return;
     const id = setTimeout(() => forms.fire("idle"), idleMs);
@@ -7062,9 +7180,13 @@ function App({ options, hostElement, bus }) {
       log16.info("selectConversation", { conversationId: targetConversationId });
       bus.emit("selectConversation", { conversationId: targetConversationId });
       try {
-        const res = await transport.loadConversation(targetConversationId);
+        const [res, markers] = await Promise.all([
+          transport.loadConversation(targetConversationId),
+          fetchFormMarkers(targetConversationId)
+        ]);
         const hydrated = res.messages.map(fromWireMessage);
         messagesSig.value = hydrated;
+        setFormMarkers(markers);
         conversationIdSig.value = res.conversationId;
         persistence.saveConversationId(res.conversationId);
         if (res.agent) setAgent(res.agent);
@@ -7078,7 +7200,7 @@ function App({ options, hostElement, bus }) {
         options.onError?.(err);
       }
     },
-    [transport, messagesSig, conversationIdSig, bus, options, persistence, refreshUnread]
+    [transport, messagesSig, conversationIdSig, bus, options, persistence, refreshUnread, fetchFormMarkers]
   );
   useEffect17(() => {
     const unsub = bindHostCommands(hostElement, {
@@ -7097,10 +7219,10 @@ function App({ options, hostElement, bus }) {
   );
   const enrichedFormMarkers = useMemo3(
     () => formMarkers.map((m) => {
-      const def = options.forms.list.find((f) => f.id === m.formId);
+      const def = effectiveForms.list.find((f) => f.id === m.formId);
       return { ...m, title: def?.title, form: def };
     }),
-    [formMarkers, options.forms]
+    [formMarkers, effectiveForms]
   );
   const panelProps = {
     options: effectiveOptions,