@aiqa/sdk 1.5.0 → 1.6.0-develop.1

package/dist/browser/browser.d.ts

@@ -32,7 +32,7 @@ declare enum ConversationLanguage {
     ES = "es",
     FR = "fr"
 }
-type SdkEvent = Methods | "connect" | "disconnect" | "close" | "error" | "reconnect_attempt" | "reconnect_error" | "reconnect_failed" | "authenticated" | "app_version" | "FACT_VERIFIED";
+type SdkEvent = Methods | "connect" | "disconnect" | "close" | "error" | "reconnect_attempt" | "reconnect_error" | "reconnect_failed" | "authenticated" | "app_version" | "FACT_VERIFIED" | "TRANSCRIPTION_UPDATED";
 declare enum FactAnswerFormatType {
     string = "STRING",
     number = "NUMBER",
@@ -182,6 +182,72 @@ interface FactVerifiedPayload {
 type FlagFactResult = {
     success: boolean;
 };
+/**
+ * Coarse dialog-act label produced by the backend's `UtteranceEnricher`.
+ * Advisory only — do not gate production behaviour on this value; the
+ * enricher emits its best-effort categorical guess plus a separate
+ * `dialog_act_confidence` band.
+ *
+ * Mirrors `DialogAct` in
+ * `libs/types/src/utterance-enrichment.ts` on the backend.
+ */
+type DialogAct = "question" | "answer" | "acknowledgement" | "filler" | "other";
+/**
+ * Categorical confidence band for `dialog_act` ONLY. Named distinctly
+ * from the numeric STT `confidence` field on the same utterance — the
+ * two are unrelated and conflating them is a documented drift hazard on
+ * the backend.
+ *
+ * Mirrors `DialogActConfidence` in
+ * `libs/types/src/utterance-enrichment.ts` on the backend.
+ */
+type DialogActConfidence = "high" | "medium" | "low";
+/**
+ * Persisted utterance shape — matches `TranscriptionUtteranceDto` on the
+ * gateway (`apps/realtime-verification/src/socket/realtimeVerification.gateway.output.dto.ts`)
+ * and the `Utterance` interface in `libs/types/src/common.ts` field for
+ * field. Sent over the wire by the `TRANSCRIPTION_UPDATED` broadcast.
+ *
+ * The 7 enricher classification fields are all optional because
+ * pre-cutover utterances (persisted before backend PR #234) lack them.
+ * Treat any missing or nullish value as "unknown" — NOT as a deliberate
+ * negative signal. `is_ivr_filler_candidate === false` in particular
+ * does NOT round-trip through `undefined`, so consumer logic that wants
+ * "definitely not a filler" must check `=== false` after confirming the
+ * field is present.
+ */
+type Utterance = {
+    /** UUIDv7 — chronologically sortable. Use `id` (NOT `order`) for sorting. */
+    id: string;
+    call_id: number;
+    /**
+     * NOT YET IMPLEMENTED — currently hardcoded to 0 at write sites on
+     * the backend. Do not use for sorting; sort by `id` (UUIDv7) instead.
+     */
+    order: number;
+    is_agent: boolean | null;
+    speaker: number;
+    text: string;
+    text_en: string | null;
+    start_time: number;
+    end_time: number;
+    dialog_act?: DialogAct;
+    dialog_act_confidence?: DialogActConfidence;
+    confidence?: number | null;
+    top_alt_margin?: number | null;
+    is_ivr_filler_candidate?: boolean;
+    spoken_digits_normalized?: string | null;
+    vendor?: string | null;
+};
+/**
+ * Payload of the `TRANSCRIPTION_UPDATED` broadcast event. Mirrors
+ * `TranscriptionUpdateResponseDto` on the gateway.
+ */
+type TranscriptionUpdate = {
+    policyNumber: string;
+    conversationId: string;
+    utterance: Utterance;
+};
 type SdkError = {
     code: "INVALID_CONFIG" | "CONNECTION_ERROR" | "TIMEOUT" | "SERVER_ERROR" | "UNEXPECTED_RESPONSE";
     message: string;
@@ -191,7 +257,7 @@ declare abstract class IAiqaSdk {
     abstract connect(): void;
     abstract disconnect(): void;
     abstract on(eventName: string, callback: (...args: any[]) => any): void;
-    abstract off(eventName: string): void;
+    abstract off(eventName: string, callback?: (...args: any[]) => any): void;
     abstract getApplication(): Promise<Application>;
     abstract addFact(fact: ApplicationFactInput): Promise<AddFactResult>;
     abstract flagFact(factId: string): Promise<FlagFactResult>;
@@ -208,6 +274,7 @@ declare class AiQaSdk implements IAiqaSdk {
     cachedApplication?: Application;
     internalListeners: Map<SdkEvent, Set<(...args: any[]) => void>>;
     internalEvents: Set<SdkEvent>;
+    private wrappersByEvent;
     constructor(applicationId: string, applicationSecret: string, url?: string);
     on(name: SdkEvent, callback: (...args: any[]) => any): void;
     off(name: SdkEvent, callback?: (...args: any[]) => any): void;
@@ -229,4 +296,4 @@ declare class AiQaSdk implements IAiqaSdk {
     private isManagerEvent;
 }
 
-export { type AddFactResult, AiQaSdk, type Application, type ApplicationFact, type ApplicationFactAnswerChoice, type ApplicationFactAnswerFormat, type ApplicationFactInput, ConversationLanguage, FactAnswerFormatType, type FactVerifiedPayload, type FlagFactResult, IAiqaSdk, Methods, type QuestionStatus, type SdkError, type SdkEvent, type SetConversationLanguageResult, type SetConversationProductResult, type VerificationStatus };
+export { type AddFactResult, AiQaSdk, type Application, type ApplicationFact, type ApplicationFactAnswerChoice, type ApplicationFactAnswerFormat, type ApplicationFactInput, ConversationLanguage, type DialogAct, type DialogActConfidence, FactAnswerFormatType, type FactVerifiedPayload, type FlagFactResult, IAiqaSdk, Methods, type QuestionStatus, type SdkError, type SdkEvent, type SetConversationLanguageResult, type SetConversationProductResult, type TranscriptionUpdate, type Utterance, type VerificationStatus };

package/dist/browser/browser.js

@@ -3396,7 +3396,7 @@ var compareVersions = (left, right) => {
 // package.json
 var package_default = {
   name: "@aiqa/sdk",
-  version: "1.5.0-develop.1",
+  version: "1.5.0-develop.4",
   main: "dist/node/node.js",
   module: "dist/node/node.js",
   types: "dist/node/node.d.ts",
@@ -3478,9 +3478,43 @@ var package_default = {
 var SDK_VERSION = package_default.version ?? "0.0.1";
 var DEFAULT_URL = "ws://localhost:3025/ws";
 var DEFAULT_TIMEOUT_MS = 6e4;
+var RUNTIME = typeof window !== "undefined" && typeof window.document !== "undefined" ? "browser" : "node";
+var USER_AGENT = RUNTIME === "browser" ? typeof navigator !== "undefined" ? navigator.userAgent : "browser/unknown" : typeof process !== "undefined" ? `node ${process.version} ${process.platform}` : "node/unknown";
+function isThenable(value2) {
+  return value2 !== null && typeof value2 === "object" && typeof value2.then === "function";
+}
+function wrapAckHandler(callback) {
+  return (...args) => {
+    const last = args[args.length - 1];
+    const hasAck = typeof last === "function";
+    const payload = hasAck ? args.slice(0, -1) : args;
+    try {
+      const handlerResult = callback(...payload);
+      if (isThenable(handlerResult)) {
+        handlerResult.then(void 0, (err) => {
+          console.error("[AiQaSdk] async event handler rejected:", err);
+        });
+      }
+    } catch (err) {
+      console.error("[AiQaSdk] event handler threw:", err);
+    } finally {
+      if (hasAck) {
+        try {
+          last();
+        } catch {
+        }
+      }
+    }
+  };
+}
 var AiQaSdk = class {
   constructor(applicationId, applicationSecret, url2) {
     this.socket = null;
+    // event → originalCallback → Set<wrappedCallback> registered on
+    // socket.io. A Set per (event, callback) so that subscribing the
+    // same fn twice registers two wrappers and two off() calls clear
+    // both.
+    this.wrappersByEvent = /* @__PURE__ */ new Map();
     this.url = url2 ?? DEFAULT_URL;
     this.internalListeners = /* @__PURE__ */ new Map();
     this.internalEvents = /* @__PURE__ */ new Set(["authenticated"]);
@@ -3505,7 +3539,19 @@ var AiQaSdk = class {
     if (this.isManagerEvent(name)) {
       this.socket.io.on(name, callback);
     } else {
-      this.socket.on(name, callback);
+      const wrapped = wrapAckHandler(callback);
+      let wrappersByCallback = this.wrappersByEvent.get(name);
+      if (!wrappersByCallback) {
+        wrappersByCallback = /* @__PURE__ */ new Map();
+        this.wrappersByEvent.set(name, wrappersByCallback);
+      }
+      let wrappers = wrappersByCallback.get(callback);
+      if (!wrappers) {
+        wrappers = /* @__PURE__ */ new Set();
+        wrappersByCallback.set(callback, wrappers);
+      }
+      wrappers.add(wrapped);
+      this.socket.on(name, wrapped);
     }
   }
   off(name, callback) {
@@ -3528,6 +3574,25 @@ var AiQaSdk = class {
     }
     if (this.isManagerEvent(name)) {
       this.socket.io.off(name, callback);
+      return;
+    }
+    if (!callback) {
+      this.socket.off(name);
+      this.wrappersByEvent.delete(name);
+      return;
+    }
+    const wrappersByCallback = this.wrappersByEvent.get(name);
+    const wrappers = wrappersByCallback?.get(callback);
+    if (wrappers && wrappers.size > 0) {
+      const wrapped = wrappers.values().next().value;
+      wrappers.delete(wrapped);
+      this.socket.off(name, wrapped);
+      if (wrappers.size === 0) {
+        wrappersByCallback.delete(callback);
+        if (wrappersByCallback.size === 0) {
+          this.wrappersByEvent.delete(name);
+        }
+      }
     } else {
       this.socket.off(name, callback);
     }
@@ -3545,34 +3610,38 @@ var AiQaSdk = class {
     this.socket.on("connect", () => {
       this.authenticate();
     });
-    this.socket.on("app_version", (payload) => {
-      let versionRange = payload;
-      if (typeof payload === "string") {
-        try {
-          versionRange = JSON.parse(payload);
-        } catch (error) {
-          versionRange = payload;
+    this.socket.on(
+      "app_version",
+      wrapAckHandler((payload) => {
+        let versionRange = payload;
+        if (typeof payload === "string") {
+          try {
+            versionRange = JSON.parse(payload);
+          } catch (error) {
+            versionRange = payload;
+          }
         }
-      }
-      const minVersion = versionRange?.min;
-      const maxVersion = versionRange?.max;
-      if (minVersion || maxVersion) {
-        const tooLow = minVersion ? compareVersions(SDK_VERSION, minVersion) < 0 : false;
-        const tooHigh = maxVersion ? compareVersions(SDK_VERSION, maxVersion) > 0 : false;
-        if (tooLow || tooHigh) {
-          const error = new Error(
-            `SDK version ${SDK_VERSION} is not supported. Supported range: ${minVersion || "-"} to ${maxVersion || "-"}.`
-          );
-          this.socket.disconnect();
-          this.socket.emit("error", error);
+        const minVersion = versionRange?.min;
+        const maxVersion = versionRange?.max;
+        if (minVersion || maxVersion) {
+          const tooLow = minVersion ? compareVersions(SDK_VERSION, minVersion) < 0 : false;
+          const tooHigh = maxVersion ? compareVersions(SDK_VERSION, maxVersion) > 0 : false;
+          if (tooLow || tooHigh) {
+            const error = new Error(
+              `SDK version ${SDK_VERSION} is not supported. Supported range: ${minVersion || "-"} to ${maxVersion || "-"}.`
+            );
+            this.socket.disconnect();
+            this.socket.emit("error", error);
+          }
         }
-      }
-    });
+      })
+    );
   }
   disconnect() {
     if (this.socket) {
       this.socket.disconnect();
     }
+    this.wrappersByEvent.clear();
   }
   sendMessage(method, data) {
     return new Promise((resolve, reject) => {
@@ -3669,7 +3738,10 @@ var AiQaSdk = class {
     try {
       const result = await this.sendMessage("AUTHENTICATE" /* AUTHENTICATE */, {
         applicationId: this.applicationId,
-        applicationSecretKey: this.applicationSecretKey
+        applicationSecretKey: this.applicationSecretKey,
+        sdkVersion: SDK_VERSION,
+        runtime: RUNTIME,
+        userAgent: USER_AGENT
       });
       const application = result && result.data !== void 0 ? result.data : result;
       this.cachedApplication = application;