@talkpilot/core-db 1.1.19 → 1.2.0

package/src/talkpilot/calls/calls.types.ts

@@ -1,115 +1,171 @@
-import { ObjectId, Sort, WithId } from "mongodb";
-import { TranscriptionSegment } from "../results";
-
-export const CONFERENCE_ROLE_CUSTOMER = "customer" as const;
-export const CONFERENCE_ROLE_SUPERVISOR = "supervisor" as const;
-
-export type ConferenceRole =
-  | typeof CONFERENCE_ROLE_CUSTOMER
-  | typeof CONFERENCE_ROLE_SUPERVISOR
-  | null;
-
-export type Call = {
-  callSid: string;
-  flowId: ObjectId;
-  clientId: string;
-  sessionId: ObjectId | null;
-  runId?: string;
-  resultId: ObjectId;
-  customerPhoneNumber: string;
-  agentPhoneNumber: string;
-  isIncomingCall: boolean;
-  isOutgoingCall: boolean;
-  callLength: number;
-  transcription?: TranscriptionSegment[];
-  status?: string;
-  leads?: Record<string, string>[];
-  summary?: string;
-  recordingUrl?: string;
-  env: string;
-  updatedAt: Date;
-  createdAt: Date;
-  isAnsweredByAnsweringMachine?: boolean;
-  agentHungUp?: boolean;
-  endReason?: string;
-  conferenceName?: string | null;
-  conferenceSid?: string | null;
-  conferenceParticipantSid?: string | null;
-  isConferenceCall?: boolean;
-  conferenceRole?: ConferenceRole;
-  redirectedCall?: boolean;
-  toolExecutions?: ToolExecution[];
-};
-
-export type ToolExecution = {
-  toolName: string;
-  executedAt: Date;
-  durationMs: number;
-  args: Record<string, unknown> | { _redacted: true };
-  meta: ToolExecutionMeta;
-  status: 'success' | 'error';
-  httpStatus?: number;
-  response?: Record<string, unknown>;
-};
-
-export type ToolExecutionMeta =
-    | {
-  kind: 'http';
-  url: string;
-  method: string;
-  flowToolId?: string;
-  runInBackground?: boolean;
-  sensitive?: boolean;
-}
-    | { kind: 'internal' };
-
-export type CallQueryOptions = {
-  sort?: Sort;
-  skip?: number;
-  limit?: number;
-};
-
-export type CallsFilterParams = {
-  clientId: string;
-  callSid?: string;
-  startDate?: Date;
-  endDate?: Date;
-  status?: string;
-  customerPhoneNumber?: string;
-  agentPhoneNumber?: string;
-  flowId?: string;
-  runId?: string;
-  sessionId?: string;
-  isIncoming?: boolean;
-  search?: string;
-};
-
-export type ImmutableCallFields =
-  | "customerPhoneNumber"
-  | "agentPhoneNumber"
-  | "isIncomingCall"
-  | "isOutgoingCall"
-  | "sessionId"
-  | "callSid"
-  | "flowId"
-  | "clientId"
-  | "runId"
-  | "resultId"
-  | "env"
-  | "createdAt";
-
-export type CallUpdateParams = Partial<Omit<Call, ImmutableCallFields>>;
-
-export type CallDoc = WithId<Call>;
-
-export type CallsByHour = { hour: string; calls: number };
-
-export type CountOpts = {
-  isOutgoingCall?: boolean;
-  isIncomingCall?: boolean;
-};
-
-export type DateRange = {
-  since?: Date;
-  until?: Date;
-};
+import { ObjectId, Sort, WithId } from "mongodb";
+import { TranscriptionSegment } from "../results";
+
+export const CONFERENCE_ROLE_CUSTOMER = "customer" as const;
+export const CONFERENCE_ROLE_SUPERVISOR = "supervisor" as const;
+
+export type ConferenceRole =
+  | typeof CONFERENCE_ROLE_CUSTOMER
+  | typeof CONFERENCE_ROLE_SUPERVISOR
+  | null;
+
+export type Call = {
+  callSid: string;
+  flowId: ObjectId;
+  clientId: string;
+  sessionId: ObjectId | null;
+  runId?: string;
+  resultId: ObjectId;
+  customerPhoneNumber: string;
+  agentPhoneNumber: string;
+  isIncomingCall: boolean;
+  isOutgoingCall: boolean;
+  callLength: number;
+  transcription?: TranscriptionSegment[];
+  status?: string;
+  leads?: Record<string, string>[];
+  summary?: string;
+  recordingUrl?: string;
+  env: string;
+  updatedAt: Date;
+  createdAt: Date;
+  isAnsweredByAnsweringMachine?: boolean;
+  agentHungUp?: boolean;
+  endReason?: string;
+  conferenceName?: string | null;
+  conferenceSid?: string | null;
+  conferenceParticipantSid?: string | null;
+  isConferenceCall?: boolean;
+  conferenceRole?: ConferenceRole;
+  redirectedCall?: boolean;
+  toolExecutions?: ToolExecution[];
+};
+
+export type ToolExecution = {
+  toolName: string;
+  executedAt: Date;
+  durationMs: number;
+  args: Record<string, unknown> | { _redacted: true };
+  meta: ToolExecutionMeta;
+  status: 'success' | 'error';
+  httpStatus?: number;
+  response?: Record<string, unknown>;
+};
+
+export type ToolExecutionMeta =
+    | {
+  kind: 'http';
+  url: string;
+  method: string;
+  flowToolId?: string;
+  runInBackground?: boolean;
+  sensitive?: boolean;
+}
+    | { kind: 'internal' };
+
+export type CallQueryOptions = {
+  sort?: Sort;
+  skip?: number;
+  limit?: number;
+};
+
+export type CallsFilterParams = {
+  clientId: string;
+  callSid?: string;
+  startDate?: Date;
+  endDate?: Date;
+  status?: string;
+  customerPhoneNumber?: string;
+  agentPhoneNumber?: string;
+  flowId?: string;
+  runId?: string;
+  sessionId?: string;
+  isIncoming?: boolean;
+  search?: string;
+};
+
+export type ImmutableCallFields =
+  | "customerPhoneNumber"
+  | "agentPhoneNumber"
+  | "isIncomingCall"
+  | "isOutgoingCall"
+  | "sessionId"
+  | "callSid"
+  | "flowId"
+  | "clientId"
+  | "runId"
+  | "resultId"
+  | "env"
+  | "createdAt";
+
+export type CallUpdateParams = Partial<Omit<Call, ImmutableCallFields>>;
+
+export type CallDoc = WithId<Call>;
+
+export type CallsByHour = { hour: string; calls: number };
+
+export type CountOpts = {
+  isOutgoingCall?: boolean;
+  isIncomingCall?: boolean;
+};
+
+export type DateRange = {
+  since?: Date;
+  until?: Date;
+};
+
+export type HourlyBucket = {
+  hour: string;
+  calls: number;
+}
+
+export type DailyBucket = {
+  date: string;
+  count: number;
+  completed: number;
+}
+
+export type CallLengthBuckets = {
+  short: number;
+  medium: number;
+  long: number;
+}
+
+export type DashboardKpis = {
+  totalCalls: number;
+  avgDurationSeconds: number;
+  timeSavedMinutes: number;
+  successRate: number;
+  completedCount: number;
+  failedCount: number;
+  noAnswerCount: number;
+  busyCount: number;
+}
+
+export type DashboardCharts = {
+  volumeData: DailyBucket[];
+  heatmap: Record<string, HourlyBucket[]>;
+  callLengthBuckets: CallLengthBuckets;
+}
+
+export type DashboardStatsParams = {
+  clientId: string;
+  startDate: string;
+  endDate: string;
+}
+
+export type RecentCall = {
+  callSid: string;
+  customerPhoneNumber: string;
+  status: string | undefined;
+  callLength: number;
+  createdAt: Date;
+  summary: string | undefined;
+  isIncomingCall: boolean;
+}
+
+export type DashboardStatsResult = {
+  kpis: DashboardKpis;
+  charts: DashboardCharts;
+  recentCalls: RecentCall[];
+}

package/src/talkpilot/calls/index.ts

@@ -1,2 +1,2 @@
-export * from "./calls.types";
-export * from "./calls.getters";
+export * from "./calls.types";
+export * from "./calls.getters";

package/src/talkpilot/clientAudioBuffers/__tests__/clientAudioBuffer.getters.spec.ts

@@ -1,160 +1,160 @@
-import {
-  getClientAudioBuffersCollection,
-  insertClientAudioBuffer,
-  findClientAudioBuffersByCallSidAndRange,
-  getMergedAudioByCallSid,
-  getAudioChunksByCallSid,
-} from "../clientAudioBuffer.getters";
-import { ObjectId } from "../../index";
-import { createAudioBufferInput } from "../../../test-utils/factories";
-
-describe("clientAudioBuffers getters", () => {
-  it('should return the "clientAudioBuffers" collection', () => {
-    const collection = getClientAudioBuffersCollection();
-    expect(collection.collectionName).toBe("clientAudioBuffers");
-  });
-
-  it("should insert a client audio buffer and return insertedId", async () => {
-    const inputToCheck = createAudioBufferInput();
-    const result = await insertClientAudioBuffer(inputToCheck);
-    expect(result.insertedId).toBeInstanceOf(ObjectId);
-
-    const savedDoc = await getClientAudioBuffersCollection().findOne({
-      _id: result.insertedId,
-    });
-    expect(savedDoc).toBeDefined();
-    expect(savedDoc?.createdAt).toBeInstanceOf(Date);
-    expect(savedDoc?.expiresAt).toBeInstanceOf(Date);
-  });
-
-  it("should return only buffers in the specified bucketStartMs range", async () => {
-    const callSid = "CA1234567890abcdef1234567890abcdef";
-    await insertClientAudioBuffer(
-      createAudioBufferInput({ callSid, bucketStartMs: 500 }),
-    );
-    await insertClientAudioBuffer(
-      createAudioBufferInput({ callSid, bucketStartMs: 1000 }),
-    );
-    await insertClientAudioBuffer(
-      createAudioBufferInput({ callSid, bucketStartMs: 3000 }),
-    );
-    await insertClientAudioBuffer(
-      createAudioBufferInput({ callSid, bucketStartMs: 6000 }),
-    );
-
-    const result = await findClientAudioBuffersByCallSidAndRange(
-      callSid,
-      500,
-      3000,
-    );
-    expect(result).toHaveLength(3);
-    const bucketStartValues = result.map((doc) => doc.bucketStartMs);
-    const bucketStartsSorted = bucketStartValues.sort((a, b) => a - b);
-    expect(bucketStartsSorted).toEqual([500, 1000, 3000]);
-  });
-
-  it("should return all buffers when no range is provided", async () => {
-    const callSid = "CA1234567890abcdef1234567890abcdeg";
-    await insertClientAudioBuffer(
-      createAudioBufferInput({ callSid, bucketStartMs: 500 }),
-    );
-    await insertClientAudioBuffer(
-      createAudioBufferInput({ callSid, bucketStartMs: 1000 }),
-    );
-    await insertClientAudioBuffer(
-      createAudioBufferInput({ callSid, bucketStartMs: 3000 }),
-    );
-
-    const result = await findClientAudioBuffersByCallSidAndRange(callSid);
-    expect(result).toHaveLength(3);
-    const bucketStartValues = result.map((doc) => doc.bucketStartMs);
-    const bucketStartsSorted = bucketStartValues.sort((a, b) => a - b);
-    expect(bucketStartsSorted).toEqual([500, 1000, 3000]);
-  });
-
-  it("should merge audio buffers by callSid in chronological order", async () => {
-    const callSid = "CA1234567890abcdef1234567890abcdeh";
-
-    const firstBuffer = Buffer.from([1, 2]);
-    const secondBuffer = Buffer.from([3]);
-    const thirdBuffer = Buffer.from([4, 5]);
-
-    await insertClientAudioBuffer(
-      createAudioBufferInput({
-        callSid,
-        bucketStartMs: 1000,
-        data: secondBuffer,
-      }),
-    );
-    await insertClientAudioBuffer(
-      createAudioBufferInput({
-        callSid,
-        bucketStartMs: 500,
-        data: firstBuffer,
-      }),
-    );
-    await insertClientAudioBuffer(
-      createAudioBufferInput({
-        callSid,
-        bucketStartMs: 3000,
-        data: thirdBuffer,
-      }),
-    );
-
-    const merged = await getMergedAudioByCallSid(callSid, 10);
-    const expected = Buffer.concat([firstBuffer, secondBuffer, thirdBuffer]);
-
-    expect(merged).toBeInstanceOf(Buffer);
-    expect(merged.length).toBe(expected.length);
-    expect(merged.equals(expected)).toBe(true);
-  });
-
-  it("should return all audio chunks when less than or equal to limit buffers exist", async () => {
-    const callSid = "CA1234567890abcdef1234567890abclt";
-
-    const limit = 30;
-    const buffers: Buffer[] = [];
-    for (let i = 0; i < limit; i++) {
-      const buf = Buffer.from([i]);
-      buffers.push(buf);
-      await insertClientAudioBuffer(
-        createAudioBufferInput({
-          callSid,
-          bucketStartMs: 1000 + i * 1000,
-          data: buf,
-        }),
-      );
-    }
-
-    const chunks = await getAudioChunksByCallSid(callSid, limit);
-
-    expect(chunks).toHaveLength(buffers.length);
-    expect(chunks.every((chunk) => chunk instanceof Buffer)).toBe(true);
-    expect(Buffer.concat(chunks).equals(Buffer.concat(buffers))).toBe(true);
-  });
-
-  it("should return only the last N audio chunks when more than limit buffers exist", async () => {
-    const callSid = "CA1234567890abcdef1234567890abclm";
-
-    const limit = 30;
-    const buffers: Buffer[] = [];
-    for (let i = 0; i < 35; i++) {
-      const buf = Buffer.from([i]);
-      buffers.push(buf);
-      await insertClientAudioBuffer(
-        createAudioBufferInput({
-          callSid,
-          bucketStartMs: 1000 + i * 1000,
-          data: buf,
-        }),
-      );
-    }
-
-    const chunks = await getAudioChunksByCallSid(callSid, limit);
-    const expectedBuffers = buffers.slice(-limit);
-    expect(chunks).toHaveLength(expectedBuffers.length);
-    expect(Buffer.concat(chunks).equals(Buffer.concat(expectedBuffers))).toBe(
-      true,
-    );
-  });
-});
+import {
+  getClientAudioBuffersCollection,
+  insertClientAudioBuffer,
+  findClientAudioBuffersByCallSidAndRange,
+  getMergedAudioByCallSid,
+  getAudioChunksByCallSid,
+} from "../clientAudioBuffer.getters";
+import { ObjectId } from "../../index";
+import { createAudioBufferInput } from "../../../test-utils/factories";
+
+describe("clientAudioBuffers getters", () => {
+  it('should return the "clientAudioBuffers" collection', () => {
+    const collection = getClientAudioBuffersCollection();
+    expect(collection.collectionName).toBe("clientAudioBuffers");
+  });
+
+  it("should insert a client audio buffer and return insertedId", async () => {
+    const inputToCheck = createAudioBufferInput();
+    const result = await insertClientAudioBuffer(inputToCheck);
+    expect(result.insertedId).toBeInstanceOf(ObjectId);
+
+    const savedDoc = await getClientAudioBuffersCollection().findOne({
+      _id: result.insertedId,
+    });
+    expect(savedDoc).toBeDefined();
+    expect(savedDoc?.createdAt).toBeInstanceOf(Date);
+    expect(savedDoc?.expiresAt).toBeInstanceOf(Date);
+  });
+
+  it("should return only buffers in the specified bucketStartMs range", async () => {
+    const callSid = "CA1234567890abcdef1234567890abcdef";
+    await insertClientAudioBuffer(
+      createAudioBufferInput({ callSid, bucketStartMs: 500 }),
+    );
+    await insertClientAudioBuffer(
+      createAudioBufferInput({ callSid, bucketStartMs: 1000 }),
+    );
+    await insertClientAudioBuffer(
+      createAudioBufferInput({ callSid, bucketStartMs: 3000 }),
+    );
+    await insertClientAudioBuffer(
+      createAudioBufferInput({ callSid, bucketStartMs: 6000 }),
+    );
+
+    const result = await findClientAudioBuffersByCallSidAndRange(
+      callSid,
+      500,
+      3000,
+    );
+    expect(result).toHaveLength(3);
+    const bucketStartValues = result.map((doc) => doc.bucketStartMs);
+    const bucketStartsSorted = bucketStartValues.sort((a, b) => a - b);
+    expect(bucketStartsSorted).toEqual([500, 1000, 3000]);
+  });
+
+  it("should return all buffers when no range is provided", async () => {
+    const callSid = "CA1234567890abcdef1234567890abcdeg";
+    await insertClientAudioBuffer(
+      createAudioBufferInput({ callSid, bucketStartMs: 500 }),
+    );
+    await insertClientAudioBuffer(
+      createAudioBufferInput({ callSid, bucketStartMs: 1000 }),
+    );
+    await insertClientAudioBuffer(
+      createAudioBufferInput({ callSid, bucketStartMs: 3000 }),
+    );
+
+    const result = await findClientAudioBuffersByCallSidAndRange(callSid);
+    expect(result).toHaveLength(3);
+    const bucketStartValues = result.map((doc) => doc.bucketStartMs);
+    const bucketStartsSorted = bucketStartValues.sort((a, b) => a - b);
+    expect(bucketStartsSorted).toEqual([500, 1000, 3000]);
+  });
+
+  it("should merge audio buffers by callSid in chronological order", async () => {
+    const callSid = "CA1234567890abcdef1234567890abcdeh";
+
+    const firstBuffer = Buffer.from([1, 2]);
+    const secondBuffer = Buffer.from([3]);
+    const thirdBuffer = Buffer.from([4, 5]);
+
+    await insertClientAudioBuffer(
+      createAudioBufferInput({
+        callSid,
+        bucketStartMs: 1000,
+        data: secondBuffer,
+      }),
+    );
+    await insertClientAudioBuffer(
+      createAudioBufferInput({
+        callSid,
+        bucketStartMs: 500,
+        data: firstBuffer,
+      }),
+    );
+    await insertClientAudioBuffer(
+      createAudioBufferInput({
+        callSid,
+        bucketStartMs: 3000,
+        data: thirdBuffer,
+      }),
+    );
+
+    const merged = await getMergedAudioByCallSid(callSid, 10);
+    const expected = Buffer.concat([firstBuffer, secondBuffer, thirdBuffer]);
+
+    expect(merged).toBeInstanceOf(Buffer);
+    expect(merged.length).toBe(expected.length);
+    expect(merged.equals(expected)).toBe(true);
+  });
+
+  it("should return all audio chunks when less than or equal to limit buffers exist", async () => {
+    const callSid = "CA1234567890abcdef1234567890abclt";
+
+    const limit = 30;
+    const buffers: Buffer[] = [];
+    for (let i = 0; i < limit; i++) {
+      const buf = Buffer.from([i]);
+      buffers.push(buf);
+      await insertClientAudioBuffer(
+        createAudioBufferInput({
+          callSid,
+          bucketStartMs: 1000 + i * 1000,
+          data: buf,
+        }),
+      );
+    }
+
+    const chunks = await getAudioChunksByCallSid(callSid, limit);
+
+    expect(chunks).toHaveLength(buffers.length);
+    expect(chunks.every((chunk) => chunk instanceof Buffer)).toBe(true);
+    expect(Buffer.concat(chunks).equals(Buffer.concat(buffers))).toBe(true);
+  });
+
+  it("should return only the last N audio chunks when more than limit buffers exist", async () => {
+    const callSid = "CA1234567890abcdef1234567890abclm";
+
+    const limit = 30;
+    const buffers: Buffer[] = [];
+    for (let i = 0; i < 35; i++) {
+      const buf = Buffer.from([i]);
+      buffers.push(buf);
+      await insertClientAudioBuffer(
+        createAudioBufferInput({
+          callSid,
+          bucketStartMs: 1000 + i * 1000,
+          data: buf,
+        }),
+      );
+    }
+
+    const chunks = await getAudioChunksByCallSid(callSid, limit);
+    const expectedBuffers = buffers.slice(-limit);
+    expect(chunks).toHaveLength(expectedBuffers.length);
+    expect(Buffer.concat(chunks).equals(Buffer.concat(expectedBuffers))).toBe(
+      true,
+    );
+  });
+});