@fonoster/callrecord 0.30.0 → 0.31.0

package/dist/CallRecordWriter.d.ts

@@ -46,7 +46,7 @@ export type CallRecordWriterOptions = {
 };
 /**
  * Builds call records live and seals them at hangup (call-record "The record is built during the
- * call and sealed at hangup"). It implements the gateway's CallRecordSink interface.
+ * call and sealed at hangup"). It implements AppBridge's CallRecordSink interface.
  */
 export declare class CallRecordWriter {
     private readonly options;
@@ -92,7 +92,7 @@ export declare class CallRecordWriter {
     private sealed;
     /**
      * Seals records whose calls stopped appending more than `deadlineMs` ago without a hangup (a
-     * gateway that crashed). Returns the callRefs sealed.
+     * appbridge that crashed). Returns the callRefs sealed.
      */
     sweep(now?: number, deadlineMs?: number): Promise<string[]>;
     /** Adds a version derived from the current one (it references its predecessor). */

package/dist/CallRecordWriter.js

@@ -108,7 +108,7 @@ function assertSameWorkspace(callRef, stored, expected) {
 const OTHER_SEAL_WAIT_MS = 120000;
 /**
  * Builds call records live and seals them at hangup (call-record "The record is built during the
- * call and sealed at hangup"). It implements the gateway's CallRecordSink interface.
+ * call and sealed at hangup"). It implements AppBridge's CallRecordSink interface.
  */
 class CallRecordWriter {
     constructor(options) {
@@ -304,7 +304,7 @@ class CallRecordWriter {
     }
     /**
      * Seals records whose calls stopped appending more than `deadlineMs` ago without a hangup (a
-     * gateway that crashed). Returns the callRefs sealed.
+     * appbridge that crashed). Returns the callRefs sealed.
      */
     sweep() {
         return __awaiter(this, arguments, void 0, function* (now = Date.now(), deadlineMs = exports.SEAL_DEADLINE_MS) {

package/dist/indexEntry.d.ts

@@ -14,6 +14,8 @@ export type RecordIndexEntry = {
     endReason: string | null;
     failureReason: string | null;
     sipStatus: number | null;
+    /** Who answered, by AMD: human, voicemail, ivr, machine or unknown; null when AMD didn't run. */
+    amdStatus: string | null;
     startedAt: string;
     endedAt: string | null;
     durationSeconds: number;
@@ -25,8 +27,20 @@ export type RecordIndexEntry = {
     size: number;
     /** Parts present in this version: recording, messages, transcript. */
     parts: string[];
+    /** How the call started: call or browser_test (add-usage-metering). */
+    origin?: string;
+    /** The call's usage lines, signed with the record (add-usage-metering). */
+    usage?: IndexUsageLine[];
 };
-/** NATS subject the gateway publishes index entries on; the control plane consumes it. */
+/** One usage line as the index carries it; the control plane validates it against its meters. */
+export type IndexUsageLine = {
+    meter: string;
+    quantity: number;
+    provider?: string;
+    model?: string;
+    keySource?: "platform" | "workspace";
+};
+/** NATS subject AppBridge publishes index entries on; the control plane consumes it. */
 export declare const RECORD_SEALED_SUBJECT = "callrecord.sealed";
 export declare function indexEntry(callRef: string, sealed: SealedVersion | SealingVersion, vcon: Vcon, where: {
     region: string;

package/dist/indexEntry.js

@@ -21,10 +21,10 @@ exports.indexEntry = indexEntry;
  * limitations under the License.
  */
 const parts_1 = require("./parts");
-/** NATS subject the gateway publishes index entries on; the control plane consumes it. */
+/** NATS subject AppBridge publishes index entries on; the control plane consumes it. */
 exports.RECORD_SEALED_SUBJECT = "callrecord.sealed";
 function indexEntry(callRef, sealed, vcon, where) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
     const f = ((_a = vcon.fonoster) !== null && _a !== void 0 ? _a : {});
     const tel = (role) => {
         const p = vcon.parties.find((x) => x.role === role);
@@ -39,30 +39,14 @@ function indexEntry(callRef, sealed, vcon, where) {
     const size = sealed.parts.reduce((n, p) => n + (0, parts_1.partSize)(p), 0) +
         sealed.signed.payload.length +
         sealed.redacted.payload.length;
-    return {
-        callRef,
-        workspaceRef: (_d = f.workspaceRef) !== null && _d !== void 0 ? _d : null,
-        appRef: (_f = ((_e = f.appRefs) !== null && _e !== void 0 ? _e : [])[0]) !== null && _f !== void 0 ? _f : null,
-        from: tel("caller"),
-        to: tel("callee"),
-        direction: (_g = f.direction) !== null && _g !== void 0 ? _g : null,
-        status: String((_h = f.status) !== null && _h !== void 0 ? _h : "completed"),
-        endReason: (_j = f.endReason) !== null && _j !== void 0 ? _j : null,
-        failureReason: (_k = failure === null || failure === void 0 ? void 0 : failure.reason) !== null && _k !== void 0 ? _k : null,
-        sipStatus: (_l = failure === null || failure === void 0 ? void 0 : failure.sipStatus) !== null && _l !== void 0 ? _l : null,
-        startedAt,
-        endedAt,
-        durationSeconds: endedAt
+    return Object.assign(Object.assign(Object.assign({ callRef, workspaceRef: (_d = f.workspaceRef) !== null && _d !== void 0 ? _d : null, appRef: (_f = ((_e = f.appRefs) !== null && _e !== void 0 ? _e : [])[0]) !== null && _f !== void 0 ? _f : null, from: tel("caller"), to: tel("callee"), direction: (_g = f.direction) !== null && _g !== void 0 ? _g : null, status: String((_h = f.status) !== null && _h !== void 0 ? _h : "completed"), endReason: (_j = f.endReason) !== null && _j !== void 0 ? _j : null, failureReason: (_k = failure === null || failure === void 0 ? void 0 : failure.reason) !== null && _k !== void 0 ? _k : null, sipStatus: (_l = failure === null || failure === void 0 ? void 0 : failure.sipStatus) !== null && _l !== void 0 ? _l : null, amdStatus: (_o = (_m = f.amd) === null || _m === void 0 ? void 0 : _m.status) !== null && _o !== void 0 ? _o : null, startedAt,
+        endedAt, durationSeconds: endedAt
             ? Math.max(0, Math.round((Date.parse(endedAt) - Date.parse(startedAt)) / 1000))
-            : 0,
-        region: where.region,
-        location: where.location,
-        version: sealed.version,
-        size,
-        parts: [
+            : 0, region: where.region, location: where.location }, (f.origin ? { origin: String(f.origin) } : {})), (Array.isArray(f.usage) && f.usage.length
+        ? { usage: f.usage }
+        : {})), { version: sealed.version, size, parts: [
             ...(hasRecording ? ["recording"] : []),
             ...(hasTranscript ? ["transcript"] : []),
             ...(hasMessages ? ["messages"] : [])
-        ]
-    };
+        ] });
 }

package/dist/parts.d.ts

@@ -1,4 +1,4 @@
-import { FilePart, Part, SealingPart, StoredPart } from "./types";
+import type { FilePart, Part, SealingPart, StoredPart } from "./types";
 export declare const isFilePart: (p: SealingPart) => p is FilePart;
 export declare const isStoredPart: (p: SealingPart) => p is StoredPart;
 export declare const isDataPart: (p: SealingPart) => p is Part;

package/dist/recording.d.ts

@@ -34,7 +34,7 @@ export declare class Recorder {
 export declare function wavHeader(dataBytes: number, channels: number, rate?: number): Buffer<ArrayBuffer>;
 /**
  * Builds the stereo WAV (left: caller, right: agent) from a recorder's directory, or undefined
- * when nothing was recorded. Works on what a crashed gateway left behind as well.
+ * when nothing was recorded. Works on what a crashed AppBridge left behind as well.
  */
 export declare function assembleRecording(dir: string): {
     wav: Buffer;

package/dist/recording.js

@@ -72,7 +72,7 @@ const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 // Full-call recording (call-record "Recording is applied by policy", design V8): an internal
 // listener attached with media-control `listener.attach`, one unmixed RTP stream per side. The
-// recorder writes each side as raw 16 kHz PCM next to the working record, so a gateway crash
+// recorder writes each side as raw 16 kHz PCM next to the working record, so an AppBridge crash
 // keeps what was recorded; sealing turns the two sides into one stereo WAV (left: caller,
 // right: agent) and references it, with its hash, from the vCon dialog.
 exports.RECORDING_RATE = 16000;
@@ -205,7 +205,7 @@ function wavHeader(dataBytes, channels, rate = exports.RECORDING_RATE) {
 }
 /**
  * Builds the stereo WAV (left: caller, right: agent) from a recorder's directory, or undefined
- * when nothing was recorded. Works on what a crashed gateway left behind as well.
+ * when nothing was recorded. Works on what a crashed AppBridge left behind as well.
  */
 function assembleRecording(dir) {
     const metaFile = path.join(dir, "meta.json");

package/dist/sign.d.ts

@@ -1,4 +1,4 @@
-import { SignedVcon, Vcon } from "./types";
+import type { SignedVcon, Vcon } from "./types";
 export type SigningKey = {
     kid: string;
     privateKeyPem: string;

package/dist/storage.d.ts

@@ -1,7 +1,7 @@
 import { ObjectStore } from "./objectStore";
 import { Part, RecordEntry, SealedVersion, SealingVersion, SignedVcon } from "./types";
 /**
- * Working records live on the gateway's local disk while the call runs: one fsynced JSON line
+ * Working records live on AppBridge's local disk while the call runs: one fsynced JSON line
  * per entry, plus the raw recording tracks. Sealed records go to object storage (RecordStore).
  */
 export declare class FsWorkingStore {
@@ -23,7 +23,7 @@ export declare class FsWorkingStore {
     /**
      * The owner's heartbeat on a live call's working record (ST-5): moves its time of last append
      * to now without writing, so a quiet call (hold, long silence) is not taken for an abandoned
-     * one by another gateway sweeping the same directory.
+     * one by another AppBridge sweeping the same directory.
      */
     touch(callRef: string): void;
     private sealLock;

package/dist/storage.js

@@ -68,7 +68,7 @@ const path = __importStar(require("path"));
 const objectStore_1 = require("./objectStore");
 const parts_1 = require("./parts");
 /**
- * Working records live on the gateway's local disk while the call runs: one fsynced JSON line
+ * Working records live on AppBridge's local disk while the call runs: one fsynced JSON line
  * per entry, plus the raw recording tracks. Sealed records go to object storage (RecordStore).
  */
 class FsWorkingStore {
@@ -132,7 +132,7 @@ class FsWorkingStore {
     /**
      * The owner's heartbeat on a live call's working record (ST-5): moves its time of last append
      * to now without writing, so a quiet call (hold, long silence) is not taken for an abandoned
-     * one by another gateway sweeping the same directory.
+     * one by another AppBridge sweeping the same directory.
      */
     touch(callRef) {
         const now = new Date();

package/dist/types.d.ts

@@ -16,10 +16,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-/** One working-record entry, as the gateway appends it (voice-session, "Every message is part of the call record"). */
+/** One working-record entry, as AppBridge appends it (voice-session, "Every message is part of the call record"). */
 export type RecordEntry = {
     at: number;
-    source: "app" | "gateway" | "event";
+    source: "app" | "appbridge" | "event";
     message: Record<string, unknown>;
 };
 /** A part stored next to the vCon (vCon external references with content hashes). */

package/dist/vcon.d.ts

@@ -1,5 +1,5 @@
-import { BeepSpan } from "./recording";
-import { RecordEntry, SealingPart, Vcon } from "./types";
+import type { BeepSpan } from "./recording";
+import type { RecordEntry, SealingPart, Vcon } from "./types";
 /**
  * Pinned to draft-ietf-vcon-vcon-core-04 (September 2026), which requires "0.4.0" (call-record
  * open question O4).

package/dist/vcon.js

@@ -48,7 +48,7 @@ const iso = (ms) => new Date(ms).toISOString();
  * attached part with a content hash. Lists what is missing (recording, SIP trace, hangup).
  */
 function buildVcon(callRef, entries, options) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
     const parties = [];
     const dialog = [];
     const decisions = [];
@@ -60,8 +60,14 @@ function buildVcon(callRef, entries, options) {
     let endedAt;
     let endReason;
     const failures = [];
+    // Audio filters that failed, at start or mid-call, with the reason (for the "Unfiltered" badge).
+    const filterFailures = [];
+    // The call's usage: each snapshot holds all of it, so the last one wins (add-usage-metering).
+    let usage;
     let started;
     let failure;
+    // Who answered (AMD), as AppBridge reported it: the first verdict is the call's.
+    let amd;
     let recordingPolicy;
     let recordingFailed;
     let consentRequested = false;
@@ -71,7 +77,7 @@ function buildVcon(callRef, entries, options) {
     for (const e of entries) {
         const m = e.message;
         const type = m.type;
-        if (e.source === "gateway" && type === "session.start") {
+        if (e.source === "appbridge" && type === "session.start") {
             if (!parties.length) {
                 startedAt = e.at;
                 parties.push({ tel: m.from, role: "caller" }, { tel: m.to, role: "callee" });
@@ -81,7 +87,7 @@ function buildVcon(callRef, entries, options) {
                 appParty.set(appRef, parties.push({ name: appRef, role: "agent", meta: { appRef } }) - 1);
             currentApp = appParty.get(appRef);
         }
-        else if (e.source === "gateway" && type === "turn.ended") {
+        else if (e.source === "appbridge" && type === "turn.ended") {
             const turn = {
                 type: "text",
                 start: iso(e.at),
@@ -104,11 +110,11 @@ function buildVcon(callRef, entries, options) {
             userStartedAt = undefined;
             decisions.push(Object.assign({ at: iso(e.at) }, m));
         }
-        else if (e.source === "gateway" && type === "turn.user_started") {
+        else if (e.source === "appbridge" && type === "turn.user_started") {
             userStartedAt !== null && userStartedAt !== void 0 ? userStartedAt : (userStartedAt = e.at);
             decisions.push(Object.assign({ at: iso(e.at) }, m));
         }
-        else if (e.source === "gateway" &&
+        else if (e.source === "appbridge" &&
             (type === null || type === void 0 ? void 0 : type.startsWith("turn.")) &&
             type !== "turn.estimate") {
             decisions.push(Object.assign({ at: iso(e.at) }, m));
@@ -119,12 +125,12 @@ function buildVcon(callRef, entries, options) {
             s.text += String((_e = m.text) !== null && _e !== void 0 ? _e : "");
             speech.set(id, s);
         }
-        else if (e.source === "gateway" && type === "output.started") {
+        else if (e.source === "appbridge" && type === "output.started") {
             const s = speech.get(String(m.id));
             if (s)
                 s.startedAt = e.at;
         }
-        else if (e.source === "gateway" &&
+        else if (e.source === "appbridge" &&
             (type === "output.done" || type === "output.interrupted")) {
             const s = speech.get(String(m.id));
             if (s && s.text) {
@@ -152,15 +158,24 @@ function buildVcon(callRef, entries, options) {
         else if (e.source === "event" && type === "call.failed") {
             failure !== null && failure !== void 0 ? failure : (failure = Object.assign({ reason: String(m.reason) }, (typeof m.sipStatus === "number" ? { sipStatus: m.sipStatus } : {})));
         }
+        else if (e.source === "event" && type === "amd.result") {
+            amd !== null && amd !== void 0 ? amd : (amd = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({ status: String((_j = m.status) !== null && _j !== void 0 ? _j : "unknown") }, (typeof m.confidence === "number"
+                ? { confidence: m.confidence }
+                : {})), (typeof m.detector === "string" ? { detector: m.detector } : {})), (typeof m.audioMs === "number" ? { audioMs: m.audioMs } : {})), (typeof m.reason === "string" ? { reason: m.reason } : {})), { at: iso(e.at) }));
+        }
         else if (e.source === "event" && type === "recording.started") {
-            recordingPolicy = String((_j = m.policy) !== null && _j !== void 0 ? _j : "on");
+            recordingPolicy = String((_k = m.policy) !== null && _k !== void 0 ? _k : "on");
         }
         else if (e.source === "event" && type === "recording.failed") {
-            recordingFailed = String((_k = m.reason) !== null && _k !== void 0 ? _k : "error");
+            recordingFailed = String((_l = m.reason) !== null && _l !== void 0 ? _l : "error");
         }
         else if (e.source === "event" && type === "recording.consent_requested") {
             consentRequested = true;
         }
+        else if (e.source === "event" && type === "usage.snapshot") {
+            if (Array.isArray(m.lines))
+                usage = m.lines;
+        }
         else if (e.source === "event" && type === "call.ended") {
             endedAt = e.at;
             endReason = String(m.reason);
@@ -170,8 +185,17 @@ function buildVcon(callRef, entries, options) {
                 type === "filter.failed" ||
                 type === "app.dropped")) {
             failures.push(type);
+            if (type === "filter.failed") {
+                filterFailures.push(Object.assign(Object.assign({}, (m.name ? { name: String(m.name) } : {})), { reason: String((_m = m.reason) !== null && _m !== void 0 ? _m : "error") }));
+            }
         }
     }
+    // Each spoken turn starts when that side began speaking and lasts until it stopped (vCon
+    // dialog `duration`, seconds): the transcript's timings per turn and per side.
+    for (const [turn, span] of heard) {
+        turn.start = iso(span.from);
+        turn.duration = Math.max(0, span.to - span.from) / 1000;
+    }
     // A call that never reached an app has no session.start: its parties come from call.started
     // (minimal record, call-record "Calls that never reach an app get a minimal record").
     if (!parties.length && started) {
@@ -261,11 +285,11 @@ function buildVcon(callRef, entries, options) {
             url: `parts/${p.name}`,
             content_hash: (0, parts_1.partHash)(p)
         })),
-        fonoster: Object.assign(Object.assign(Object.assign({ callRef, region: options.region, startedAt: iso(startedAt), endedAt: endedAt ? iso(endedAt) : null, endReason: endReason !== null && endReason !== void 0 ? endReason : null, status, direction: (_l = started === null || started === void 0 ? void 0 : started.direction) !== null && _l !== void 0 ? _l : null, workspaceRef: (_m = started === null || started === void 0 ? void 0 : started.workspaceRef) !== null && _m !== void 0 ? _m : null, appRefs }, (failure ? { failure } : {})), (recordingPolicy || recordingFailed || consentRequested
+        fonoster: Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({ callRef, region: options.region, startedAt: iso(startedAt), endedAt: endedAt ? iso(endedAt) : null, endReason: endReason !== null && endReason !== void 0 ? endReason : null, status, direction: (_o = started === null || started === void 0 ? void 0 : started.direction) !== null && _o !== void 0 ? _o : null, workspaceRef: (_p = started === null || started === void 0 ? void 0 : started.workspaceRef) !== null && _p !== void 0 ? _p : null, appRefs }, (failure ? { failure } : {})), (amd ? { amd } : {})), (recordingPolicy || recordingFailed || consentRequested
             ? {
                 recording: Object.assign({ policy: recordingPolicy !== null && recordingPolicy !== void 0 ? recordingPolicy : null, consentRequested }, (recordingFailed ? { failed: recordingFailed } : {}))
             }
-            : {})), { complete: !missing.includes("hangup"), missing,
+            : {})), (filterFailures.length ? { filters: { failed: filterFailures } } : {})), ((started === null || started === void 0 ? void 0 : started.origin) ? { origin: started.origin } : {})), ((usage === null || usage === void 0 ? void 0 : usage.length) ? { usage } : {})), { complete: !missing.includes("hangup"), missing,
             failures })
     };
     const vcon = Object.assign(Object.assign({}, base), { uuid: (0, crypto_1.randomUUID)(), dialog });
@@ -299,7 +323,7 @@ function buildVcon(callRef, entries, options) {
     // turn that carried them, since there are no word timings yet (O3). Without a beeped copy the
     // redacted copy does not reference the recording at all.
     const beeped = redactions && recording && spans.length && !unlocatable
-        ? (_o = recording.beep) === null || _o === void 0 ? void 0 : _o.call(recording, spans)
+        ? (_q = recording.beep) === null || _q === void 0 ? void 0 : _q.call(recording, spans)
         : undefined;
     if (beeped)
         parts.push(beeped);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fonoster/callrecord",
-  "version": "0.30.0",
+  "version": "0.31.0",
   "description": "Call records: working records during calls, sealed and signed vCon files after hangup",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/fonoster#readme",
@@ -13,12 +13,11 @@
   },
   "scripts": {
     "prebuild": "rimraf ./dist tsconfig.tsbuildinfo",
-    "build": "tsc -b tsconfig.json",
-    "clean": "rimraf ./dist node_modules tsconfig.tsbuildinfo"
+    "build": "tsc -b tsconfig.json"
   },
   "dependencies": {
     "@aws-sdk/client-s3": "^3.958.0",
-    "@fonoster/logger": "^0.30.0"
+    "@fonoster/logger": "^0.31.0"
   },
   "files": [
     "dist",
@@ -40,5 +39,5 @@
   "devDependencies": {
     "ajv": "^8.18.0"
   },
-  "gitHead": "08c9cfd7932675b6b16111daa4d03f14b4e287d1"
+  "gitHead": "f0a5102dddeea0f70f659234108805bc10690f2e"
 }