@omniloy/sofia-sdk 1.0.10 → 1.0.11

package/dist/react/index.es.js

@@ -5145,7 +5145,7 @@ const {
   create: create$1,
 } = axios;
 
-const version$2 = "1.0.10";
+const version$2 = "1.0.11";
 
 const handleApiError$1 = async (error) => {
   return Promise.reject(error);
@@ -11078,6 +11078,141 @@ const useVadCoverage = () => {
   };
 };
 
+const FAMILIES = [
+  "recording",
+  "activity",
+  "report",
+  "lifecycle"
+];
+const familyOf = (name) => {
+  const prefix = name.split(".")[0];
+  return FAMILIES.includes(prefix) ? prefix : "lifecycle";
+};
+
+const compileSubscription = (patterns) => {
+  if (!patterns || patterns.length === 0) return () => false;
+  if (patterns.includes("*")) return () => true;
+  const exact = /* @__PURE__ */ new Set();
+  const families = /* @__PURE__ */ new Set();
+  for (const pattern of patterns) {
+    if (pattern.endsWith(".*")) families.add(pattern.slice(0, -2));
+    else exact.add(pattern);
+  }
+  if (families.size === 0) return (name) => exact.has(name);
+  return (name) => {
+    if (exact.has(name)) return true;
+    const dot = name.indexOf(".");
+    return dot > 0 && families.has(name.slice(0, dot));
+  };
+};
+const subscriptionKey = (patterns) => patterns ? patterns.join("|") : "";
+
+const QUEUE_CAP = 200;
+let handler = null;
+let matches = () => false;
+let sessionId = null;
+let seq = 0;
+let queue$1 = [];
+let draining = false;
+let handlerFailed = false;
+let registrations = 0;
+const drain = () => {
+  draining = false;
+  const batch = queue$1;
+  queue$1 = [];
+  const current = handler;
+  if (!current) return;
+  for (const event of batch) {
+    try {
+      current(event);
+    } catch {
+      if (!handlerFailed) {
+        handlerFailed = true;
+        logger.warn(
+          "[SdkEvents] onEvent handler threw; further failures suppressed"
+        );
+      }
+    }
+  }
+};
+const schedule = () => {
+  if (draining) return;
+  draining = true;
+  queueMicrotask(drain);
+};
+const SdkEventBus = {
+  /**
+   * Installs the host handler. Returns an unsubscribe. Events that matched
+   * the subscription but arrived before a handler existed are queued and
+   * delivered on the next microtask. That window is real: React runs child
+   * effects before parent ones, so a provider below `Omniscribe` can emit
+   * after `setSubscription` and before this call.
+   */
+  setHandler(next) {
+    registrations += 1;
+    if (next && handler && registrations > 1) {
+      logger.warn(
+        "[SdkEvents] a second onEvent handler was registered. The SDK supports one <Omniscribe> per page; the newest handler wins."
+      );
+    }
+    handler = next;
+    if (next && queue$1.length > 0) schedule();
+    return () => {
+      if (handler === next) handler = null;
+    };
+  },
+  setSubscription(patterns) {
+    matches = compileSubscription(patterns);
+  },
+  setSessionId(next) {
+    sessionId = next;
+  },
+  /**
+   * Cheap guard for callers on a hot path who would otherwise build a
+   * payload for nobody.
+   */
+  wants(name) {
+    return matches(name);
+  },
+  /**
+   * Queues an event for delivery on the next microtask.
+   *
+   * Never throws. Deferring delivery does three things at once: host code
+   * never runs inside React's render phase (where a `setState` would
+   * throw), a slow handler cannot block `socket.onmessage` on the audio
+   * path, and a handler that itself triggers an event cannot recurse —
+   * the re-entrant call only appends to a queue the current drain has
+   * already taken. One shared drain, not one microtask per event, so `seq`
+   * ordering is preserved.
+   */
+  emit(name, payload, level = "info") {
+    if (!matches(name)) return;
+    queue$1.push({
+      name,
+      family: familyOf(name),
+      level,
+      ts: (/* @__PURE__ */ new Date()).toISOString(),
+      seq: ++seq,
+      sdkVersion: version$2,
+      sessionId,
+      payload
+    });
+    if (queue$1.length > QUEUE_CAP) queue$1.shift();
+    if (handler) schedule();
+  },
+  /** Test-only: restores the module to its initial state. */
+  __resetForTests() {
+    handler = null;
+    matches = () => false;
+    sessionId = null;
+    seq = 0;
+    queue$1 = [];
+    draining = false;
+    handlerFailed = false;
+    registrations = 0;
+  }
+};
+
 const SettingsContext = React__default.createContext(
   void 0
 );
@@ -11118,6 +11253,7 @@ const SettingsProvider = ({
     DEFAULT_MINOR_AGE_THRESHOLD
   );
   const [isLoading, setIsLoading] = React__default.useState(true);
+  const hasEmittedReadyRef = React__default.useRef(false);
   const isInitializedRef = React__default.useRef(false);
   const applySettings = React__default.useCallback(
     (parsed) => {
@@ -11170,6 +11306,10 @@ const SettingsProvider = ({
       SettingsCache.getInstance().clear();
     } finally {
       setIsLoading(false);
+      if (!hasEmittedReadyRef.current) {
+        hasEmittedReadyRef.current = true;
+        SdkEventBus.emit("lifecycle.ready", {});
+      }
     }
   }, [toolArgs, templateId, predefinedLanguage, applySettings]);
   const reloadSettings = React__default.useCallback(async () => {
@@ -17282,8 +17422,147 @@ const evaluateMinorRule = ({
 
 const postAppEvent = (event) => requester.post("/app-events", event).catch(() => void 0);
 
+const ACTIVITY_THROTTLE_MS = 5e3;
+const lastEmittedAt = /* @__PURE__ */ new Map();
+const shouldEmit = (key) => {
+  const now = Date.now();
+  const previous = lastEmittedAt.get(key);
+  if (previous !== void 0 && now - previous < ACTIVITY_THROTTLE_MS) {
+    return false;
+  }
+  lastEmittedAt.set(key, now);
+  return true;
+};
+const emitInteraction = (kind) => {
+  if (!SdkEventBus.wants("activity.interaction")) return;
+  if (!shouldEmit(`interaction:${kind}`)) return;
+  SdkEventBus.emit("activity.interaction", { kind });
+};
+const emitTyping = (surface) => {
+  if (!SdkEventBus.wants("activity.typing")) return;
+  if (!shouldEmit(`typing:${surface}`)) return;
+  SdkEventBus.emit("activity.typing", { surface });
+};
+
+let open$1 = false;
+const openReportBracket = () => {
+  if (open$1) return;
+  open$1 = true;
+  SdkEventBus.emit("report.generation_started", {});
+};
+const closeReportBracket = (ok) => {
+  if (!open$1) return;
+  open$1 = false;
+  SdkEventBus.emit("report.settled", { ok });
+};
+
+const RECORDING_HEARTBEAT_MS = 3e4;
+let lastBeatAt = null;
+const emitRecordingHeartbeat = () => {
+  if (!SdkEventBus.wants("recording.heartbeat")) return;
+  const now = Date.now();
+  if (lastBeatAt !== null && now - lastBeatAt < RECORDING_HEARTBEAT_MS) return;
+  lastBeatAt = now;
+  SdkEventBus.emit("recording.heartbeat", {});
+};
+const resetRecordingHeartbeat = () => {
+  lastBeatAt = null;
+};
+
+const INTERACTION_KIND = {
+  recording_button: "recording",
+  chat_mic_button: "chat",
+  attach_file_button: "chat",
+  remove_file_button: "chat",
+  edit_message_button: "chat",
+  cancel_edit_message_button: "chat",
+  send_edit_message_button: "chat",
+  copy_human_message_button: "chat",
+  copy_ai_message_button: "chat",
+  settings_button: "settings",
+  settings_back_button: "settings",
+  settings_section_button: "settings",
+  select_audio_environment: "settings",
+  compile_summary_button: "report",
+  regenerate_summary_button: "report",
+  generate_extras_button: "report",
+  expand_transcription_button: "transcript",
+  history_thread_item: "history",
+  close_widget_button: "widget",
+  main_menu_button: "widget",
+  play_panel_button: "widget"
+};
+const CLICK_FALLBACK_KIND = "widget";
+const RECORDING_MODES = ["consultation", "dictation"];
+const AUDIO_LOSS_CAUSES = ["mic", "network", "server"];
+const readNumber = (payload, key) => {
+  const value = payload?.[key];
+  return typeof value === "number" && Number.isFinite(value) ? value : 0;
+};
+const readMode = (payload) => {
+  const value = payload?.mode;
+  return typeof value === "string" && RECORDING_MODES.includes(value) ? value : "consultation";
+};
+const readCause = (payload) => {
+  const value = payload?.cause;
+  return typeof value === "string" && AUDIO_LOSS_CAUSES.includes(value) ? value : "server";
+};
+const fanOutAppEvent = (input) => {
+  try {
+    const { event_type, event_name, payload } = input;
+    if (event_type === "click") {
+      emitInteraction(INTERACTION_KIND[event_name] ?? CLICK_FALLBACK_KIND);
+    }
+    switch (event_name) {
+      case "recording_started":
+        resetRecordingHeartbeat();
+        SdkEventBus.emit("recording.started", { mode: readMode(payload) });
+        break;
+      case "recording_stopped":
+        SdkEventBus.emit("recording.stopped", {
+          mode: readMode(payload),
+          durationSeconds: readNumber(payload, "duration_seconds")
+        });
+        break;
+      // The mic/network emitter reports the length of the gap once audio
+      // recovers. The server-close emitter has no gap to measure — capture
+      // is torn down on the spot — and reports the recording position
+      // instead, so fall back to that rather than hand the host a silent 0.
+      case "audio_lost":
+        SdkEventBus.emit(
+          "recording.audio_lost",
+          {
+            cause: readCause(payload),
+            durationSeconds: readNumber(payload, "duration_seconds") || readNumber(payload, "recording_position_seconds")
+          },
+          "warn"
+        );
+        break;
+      case "mic_disconnected":
+        SdkEventBus.emit("recording.microphone_disconnected", {}, "warn");
+        break;
+      // A report request is in flight. The host must suppress its idle
+      // timer until report.settled, or it will close the widget during
+      // generation — which looks exactly like idleness and loses the note.
+      // openReportBracket ignores a second click while one is in flight, so
+      // the pair stays balanced.
+      case "compile_summary_button":
+      case "regenerate_summary_button":
+        openReportBracket();
+        break;
+      case "close_widget_button":
+        SdkEventBus.emit("lifecycle.closed", {});
+        break;
+      default:
+        break;
+    }
+  } catch {
+  }
+};
+
 const EventTracker = {
   track(input) {
+    fanOutAppEvent(input);
     const event = {
       event_type: input.event_type,
       event_name: input.event_name,
@@ -21051,6 +21330,7 @@ const useAudioProcessor = ({
           );
           socket.send(audioData16kHz);
           lastSendAtRef.current = Date.now();
+          emitRecordingHeartbeat();
         }
       };
       audioTracks.forEach((t) => {
@@ -22540,6 +22820,7 @@ const useReportPreviewState = ({
   }, []);
   const setScalarEdit = React__default.useCallback(
     (entryKey, value) => {
+      emitTyping("note");
       setEdits((prev) => {
         const next = new Map(prev);
         next.set(entryKey, value);
@@ -22550,6 +22831,7 @@ const useReportPreviewState = ({
   );
   const setRowFieldEdit = React__default.useCallback(
     (entryKey, rowIndex, fieldKey, value) => {
+      emitTyping("note");
       setEdits((prev) => {
         const next = new Map(prev);
         next.set(rowFieldEditKey(entryKey, rowIndex, fieldKey), value);
@@ -22559,6 +22841,7 @@ const useReportPreviewState = ({
     []
   );
   const setScalarGapValue = React__default.useCallback((key, value) => {
+    emitTyping("note");
     setFilledScalarGaps((prev) => {
       const next = new Map(prev);
       next.set(key, value);
@@ -24458,6 +24741,7 @@ const useReportGeneration = (options) => {
     } finally {
       setState((prev) => ({ ...prev, generating: false }));
       regenerateInflightRef.current = false;
+      closeReportBracket(false);
     }
   }, [
     abortIfBlocked,
@@ -24498,6 +24782,7 @@ const useReportGeneration = (options) => {
         handleReport?.(result);
       }
       trackEvent("event", "summary_compiled");
+      closeReportBracket(true);
       if (patientId && doctorId) {
         await saveDayData({
           patientId,
@@ -24688,6 +24973,7 @@ const useReportGeneration = (options) => {
       }
     } finally {
       generateInflightRef.current = false;
+      closeReportBracket(false);
       setUserPendingClick(false);
       const finalPid = appointmentData?.patientId;
       const finalDid = appointmentData?.doctorId;
@@ -151315,122 +151601,108 @@ const ChatFooter = ({
           ]
         }
       ),
-      /* @__PURE__ */ jsxs(
-        "form",
-        {
-          onSubmit,
-          className: "omniscribe_chat-view-combined-footer-row",
-          children: [
-            /* @__PURE__ */ jsx$2(
-              "input",
-              {
-                ref: fileInputRef,
-                type: "file",
-                multiple: true,
-                accept: "image/*,.pdf",
-                onChange: onFileSelect,
-                style: { display: "none" }
-              }
-            ),
-            /* @__PURE__ */ jsxs(
-              "div",
-              {
-                className: `omniscribe_chat-view-combined-input-container${uploadedFiles.length > 0 ? " omniscribe_chat-view-combined-input-container--with-files" : ""}`,
-                children: [
-                  uploadedFiles.length > 0 && /* @__PURE__ */ jsx$2("div", { className: "omniscribe_chat-view-combined-files-row", children: /* @__PURE__ */ jsx$2(FilePreview, { files: uploadedFiles, onRemove: onFileRemove }) }),
-                  /* @__PURE__ */ jsxs("div", { className: "omniscribe_chat-view-combined-input-row", children: [
-                    /* @__PURE__ */ jsx$2(
-                      Tooltip,
+      /* @__PURE__ */ jsxs("div", { className: "omniscribe_chat-view-combined-footer-row", children: [
+        /* @__PURE__ */ jsx$2(
+          "input",
+          {
+            ref: fileInputRef,
+            type: "file",
+            multiple: true,
+            accept: "image/*,.pdf",
+            onChange: onFileSelect,
+            style: { display: "none" }
+          }
+        ),
+        /* @__PURE__ */ jsxs(
+          "div",
+          {
+            className: `omniscribe_chat-view-combined-input-container${uploadedFiles.length > 0 ? " omniscribe_chat-view-combined-input-container--with-files" : ""}`,
+            children: [
+              uploadedFiles.length > 0 && /* @__PURE__ */ jsx$2("div", { className: "omniscribe_chat-view-combined-files-row", children: /* @__PURE__ */ jsx$2(FilePreview, { files: uploadedFiles, onRemove: onFileRemove }) }),
+              /* @__PURE__ */ jsxs("div", { className: "omniscribe_chat-view-combined-input-row", children: [
+                /* @__PURE__ */ jsx$2(
+                  Tooltip,
+                  {
+                    message: formatMessage({ id: "Attach file" }),
+                    side: "top",
+                    children: /* @__PURE__ */ jsx$2(
+                      "button",
                       {
-                        message: formatMessage({ id: "Attach file" }),
-                        side: "top",
+                        type: "button",
+                        className: "omniscribe_chat-view-combined-clip-icon",
+                        onClick: () => {
+                          trackEvent("click", "attach_file_button");
+                          onAttachClick();
+                        },
+                        disabled: uploadedFiles.length >= MAX_FILES,
+                        "aria-label": formatMessage({ id: "Attach file" }),
                         children: /* @__PURE__ */ jsx$2(
-                          "button",
+                          "svg",
                           {
-                            type: "button",
-                            className: "omniscribe_chat-view-combined-clip-icon",
-                            onClick: () => {
-                              trackEvent("click", "attach_file_button");
-                              onAttachClick();
-                            },
-                            disabled: uploadedFiles.length >= MAX_FILES,
-                            "aria-label": formatMessage({ id: "Attach file" }),
-                            children: /* @__PURE__ */ jsx$2(
-                              "svg",
-                              {
-                                width: "12",
-                                height: "12",
-                                viewBox: "0 0 24 24",
-                                fill: "none",
-                                stroke: "currentColor",
-                                strokeWidth: "2",
-                                strokeLinecap: "round",
-                                strokeLinejoin: "round",
-                                children: /* @__PURE__ */ jsx$2("path", { d: "M21.44 11.05l-9.19 9.19a6 6 0 0 1-8.49-8.49l9.19-9.19a4 4 0 0 1 5.66 5.66l-9.2 9.19a2 2 0 0 1-2.83-2.83l8.49-8.48" })
-                              }
-                            )
+                            width: "12",
+                            height: "12",
+                            viewBox: "0 0 24 24",
+                            fill: "none",
+                            stroke: "currentColor",
+                            strokeWidth: "2",
+                            strokeLinecap: "round",
+                            strokeLinejoin: "round",
+                            children: /* @__PURE__ */ jsx$2("path", { d: "M21.44 11.05l-9.19 9.19a6 6 0 0 1-8.49-8.49l9.19-9.19a4 4 0 0 1 5.66 5.66l-9.2 9.19a2 2 0 0 1-2.83-2.83l8.49-8.48" })
                           }
                         )
                       }
-                    ),
-                    /* @__PURE__ */ jsx$2(
-                      Textarea,
-                      {
-                        ref: textareaRef,
-                        rows: 1,
-                        "data-testid": "sofia-chat-input",
-                        value: inputValue,
-                        variant: "secondary",
-                        onChange: onInputChange,
-                        onKeyDown: (e) => {
-                          if (e.key === "Enter" && !e.shiftKey && !e.metaKey) {
-                            e.preventDefault();
-                            const el = e.target;
-                            const form = el?.closest("form");
-                            form?.requestSubmit();
-                          }
-                        },
-                        maxLength: inputMaxLength,
-                        className: "omniscribe_chat-view-combined-textarea no-scrollbar text-p",
-                        placeholder: formatMessage({
-                          id: "What do you need to know?"
-                        })
-                      }
-                    ),
-                    isLoading ? /* @__PURE__ */ jsx$2(
-                      "button",
-                      {
-                        type: "button",
-                        "data-testid": "sofia-chat-stop",
-                        onClick: onStop,
-                        className: "omniscribe_chat-view-combined-send-btn omniscribe_chat-view-combined-stop-btn",
-                        title: formatMessage({ id: "Stop" }),
-                        children: /* @__PURE__ */ jsx$2(SquareIcon, { width: 10, height: 10 })
-                      }
-                    ) : inputValue.length > 0 ? /* @__PURE__ */ jsx$2(
-                      "button",
-                      {
-                        type: "button",
-                        "data-testid": "sofia-chat-send",
-                        onClick: (e) => {
-                          const form = e.currentTarget.closest(
-                            "form"
-                          );
-                          form?.requestSubmit();
-                        },
-                        className: "omniscribe_chat-view-combined-send-btn",
-                        disabled: isLoading || !inputIsValid,
-                        title: formatMessage({ id: "Send" }),
-                        children: /* @__PURE__ */ jsx$2(SendArrowIcon, { width: 16, height: 16 })
+                    )
+                  }
+                ),
+                /* @__PURE__ */ jsx$2(
+                  Textarea,
+                  {
+                    ref: textareaRef,
+                    rows: 1,
+                    "data-testid": "sofia-chat-input",
+                    value: inputValue,
+                    variant: "secondary",
+                    onChange: onInputChange,
+                    onKeyDown: (e) => {
+                      if (e.key === "Enter" && !e.shiftKey && !e.metaKey) {
+                        e.preventDefault();
+                        onSubmit(e);
                       }
-                    ) : /* @__PURE__ */ jsx$2(MicrophoneButton, { onTextUpdate: onTranscriptionUpdate })
-                  ] })
-                ]
-              }
-            )
-          ]
-        }
-      )
+                    },
+                    maxLength: inputMaxLength,
+                    className: "omniscribe_chat-view-combined-textarea no-scrollbar text-p",
+                    placeholder: formatMessage({
+                      id: "What do you need to know?"
+                    })
+                  }
+                ),
+                isLoading ? /* @__PURE__ */ jsx$2(
+                  "button",
+                  {
+                    type: "button",
+                    "data-testid": "sofia-chat-stop",
+                    onClick: onStop,
+                    className: "omniscribe_chat-view-combined-send-btn omniscribe_chat-view-combined-stop-btn",
+                    title: formatMessage({ id: "Stop" }),
+                    children: /* @__PURE__ */ jsx$2(SquareIcon, { width: 10, height: 10 })
+                  }
+                ) : inputValue.length > 0 ? /* @__PURE__ */ jsx$2(
+                  "button",
+                  {
+                    type: "button",
+                    "data-testid": "sofia-chat-send",
+                    onClick: onSubmit,
+                    className: "omniscribe_chat-view-combined-send-btn",
+                    disabled: isLoading || !inputIsValid,
+                    title: formatMessage({ id: "Send" }),
+                    children: /* @__PURE__ */ jsx$2(SendArrowIcon, { width: 16, height: 16 })
+                  }
+                ) : /* @__PURE__ */ jsx$2(MicrophoneButton, { onTextUpdate: onTranscriptionUpdate })
+              ] })
+            ]
+          }
+        )
+      ] })
     ] })
   ] });
 };
@@ -152083,6 +152355,7 @@ const ChatView = () => {
     appointmentData?.doctorId
   ]);
   const handleInputChange = (e) => {
+    emitTyping("chat");
     input.onChange(e);
     setInputIsValid(
       InputValidator.validate(e.target.value, CHAT_INPUT_VALIDATION).isValid
@@ -156492,6 +156765,9 @@ const SessionProvider = ({ children }) => {
     prevPatientIdRef.current = patientId;
     setSessionId(patientId ? generateUuid() : null);
   }, [patientId]);
+  useEffect(() => {
+    SdkEventBus.setSessionId(sessionId);
+  }, [sessionId]);
   return /* @__PURE__ */ jsx$2(SessionContext.Provider, { value: { sessionId }, children });
 };
 
@@ -156711,7 +156987,9 @@ const Omniscribe = ({
   onReportApply,
   updateTemplate,
   templateExtras,
-  handleExtras
+  handleExtras,
+  onEvent,
+  eventSubscriptions
 }) => {
   const templateFields = template ?? toolsargs;
   const effectiveBaseUrl = React.useMemo(
@@ -156760,6 +157038,28 @@ const Omniscribe = ({
   React.useEffect(() => {
     logger.setDebugMode(debug || false);
   }, [debug]);
+  const onEventRef = React.useRef(onEvent);
+  onEventRef.current = onEvent;
+  const hasEventHandler = onEvent !== void 0;
+  const subscriptionsRef = React.useRef(
+    eventSubscriptions
+  );
+  subscriptionsRef.current = eventSubscriptions;
+  const subscriptions = subscriptionKey(eventSubscriptions);
+  React.useEffect(() => {
+    SdkEventBus.setSubscription(subscriptionsRef.current);
+  }, [subscriptions]);
+  React.useEffect(() => {
+    if (!hasEventHandler) return;
+    return SdkEventBus.setHandler((event) => onEventRef.current?.(event));
+  }, [hasEventHandler]);
+  React.useEffect(() => {
+    if (hasEventHandler && !eventSubscriptions?.length) {
+      logger.warn(
+        '[Sofia SDK] onEvent was provided without eventSubscriptions, so no events will be delivered. Pass e.g. ["recording.*", "activity.*"].'
+      );
+    }
+  }, [hasEventHandler, eventSubscriptions]);
   React.useEffect(() => {
     if (apikey && apikey.trim() !== "") {
       setEncryptionSeed(apikey);