@omniloy/sofia-sdk 1.0.8 → 1.0.10

package/dist/webcomponents.d.ts

@@ -21,6 +21,14 @@ declare interface CuratedReport {
  */
 declare type ExistingTemplateValues = Record<string, unknown>;
 
+/**
+ * A single extracted action item. Its shape is defined entirely by the host's
+ * `templateExtras` schema and passed through untouched — the SDK does NOT
+ * remap or normalise fields. For SINA, for example, each item is
+ * `{ type: string; description: string }`.
+ */
+declare type Extra = Record<string, unknown>;
+
 declare interface InsertionPreviewClassNames {
     backdrop?: string;
     panel?: string;
@@ -142,8 +150,18 @@ export declare interface OmniscribeProps {
     disablegenerate?: boolean;
     /** Enable debug logging */
     debug?: boolean;
-    /** Doctor's medical specialty at the time of the event. Optional. When provided, it is attached to every tracked event for analytics segmentation. */
-    userMedicalSpecialty?: string;
+    /**
+     * Doctor's medical specialty at the time of the event. Optional. When
+     * provided, it is attached to every tracked event for analytics segmentation.
+     *
+     * All-lowercase, matching the other string props (`userid`, `patientid`,
+     * `templateid`) and the attribute the Web Component exposes.
+     *
+     * BREAKING (since v1.0.9): this replaces the camelCase `userMedicalSpecialty`
+     * that shipped in v1.0.8. React hosts passing the old name must rename it —
+     * the old spelling is no longer read and the value is silently dropped.
+     */
+    usermedicalspecialty?: string;
     /** Expose function to get last generated report */
     setGetLastReport?: (fn: () => Promise<object | undefined>) => void;
     /**
@@ -170,6 +188,36 @@ export declare interface OmniscribeProps {
      * for fields with no readable content (generation degrades gracefully).
      */
     updateTemplate?: UpdateTemplateCallback;
+    /**
+     * Template fields configuration for extras (petitions, tests, appointments, etc.).
+     * Enables the extras action button when provided (together with a transcript
+     * and a wired `handleExtras`). Each HIS defines its own field names and enum
+     * values in this template — the SDK passes them through without transformation.
+     *
+     * Follows the canonical "camelCase JS property, kebab HTML attribute" contract
+     * used by the other camelCase props (`handleReport`, `updateTemplate`,
+     * `insertionPreviewClassNames`): assign it as `el.templateExtras` (or the
+     * `template-extras` attribute on the web component).
+     */
+    templateExtras?: object;
+    /**
+     * Generic callback for the actions detected from the transcription.
+     * Fired when the user clicks an extras category button. Receives the array
+     * of items for that category, passed through EXACTLY as the LLM produced it
+     * against the `templateExtras` schema — the SDK does no field remapping or
+     * normalisation. The item shape is therefore defined by the host's schema.
+     *
+     * Example (SINA petitions — `templateExtras` items are `{ type, description }`):
+     * ```
+     * handleExtras([
+     *   { type: '3', description: 'Solicitar TAC con contraste.' },
+     *   { type: '1', description: 'Solicitar analítica completa.' },
+     * ])
+     * ```
+     * The host reads whatever fields its schema defined (e.g. `type`) to trigger
+     * the appropriate action. To change the delivered shape, change templateExtras.
+     */
+    handleExtras?: (extras: Extra[]) => void;
 }
 
 export declare const SofiaSDK: CustomElementConstructor;