@talkpilot/core-db 1.3.47 → 1.3.49

package/src/talkpilot/flows/flows.types.ts

@@ -1,189 +1,211 @@
-import { ObjectId } from "mongodb";
-
-/* ----------  Basic helpers  ---------- */
-
-export type Position = { x: number; y: number };
-export type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
-
-export type QuestionType = "open" | "multiple" | "table";
-export type SelectionType = "single" | "multiple";
-
-export type Question = {
-  id: string;
-  type: QuestionType;
-  text: string;
-  repeatAnswer?: boolean;
-  // For 'multiple' type questions:
-  answers?: string[] | null;
-  selectionType?: SelectionType | null; // 'single' = choose one, 'multiple' = choose one or more
-  // For 'table' type questions:
-  tableHeader?: string | null;
-  tableRows?: string[] | null;
-  tableColumns?: string[] | null; // These are the answer options shared across all rows
-  // Note: 'table' questions can also have selectionType to indicate if each row allows single or multiple selections
-};
-
-export type NodeKind =
-  | "start"
-  | "say"
-  | "condition"
-  | "improvise"
-  | "tool"
-  | "sendMessage"
-  | "questionsList"
-  | "end";
-type BaseNode = {
-  id: string;
-  type: NodeKind;
-  text: string;
-
-  name?: string | null;
-  position: Position;
-  children?: string[] | null;
-  successStatus?: string | null;
-  questions?: Question[] | null;
-};
-
-export type StartNode = BaseNode & { type: "start" };
-
-export type SayNode = BaseNode & { type: "say" };
-
-export type ConditionNode = BaseNode & {
-  type: "condition";
-  conditions: Array<{
-    conditionString: string;
-    nodeType?: string | null;
-    id?: string | null;
-  }>;
-  defaultNodeType?: string | null;
-  defaultChild?: { id?: string } | null;
-};
-
-export type ImproviseNode = BaseNode & { type: "improvise" };
-
-export type FlowTool = {
-  id: string;
-  name: string;
-  description?: string;
-  url: string;
-  method: HttpMethod;
-  headers?: Record<string, string>;
-  parameters: Record<string, unknown>;
-  bodyFormat?: "json" | "form-data";
-  preventAudioDuringTool?: boolean;
-  /** When true, prefer cached transcription from Redis (default: false). */
-  useRedisTranscription?: boolean;
-  sendUserAuthToken?: boolean;
-  runInBackground?: boolean;
-  backgroundToolType?: "backgroundToolAlways" | "backgroundToolOnce";
-  backgroundContinuationInstructions?: string;
-};
-
-export type SendMethod = "sms" | "whatsapp";
-
-export type SendMessageNode = BaseNode & {
-  type: "sendMessage";
-  /** Which channel to use. If omitted, decide at runtime (e.g., default to whatsapp). */
-  send_method: SendMethod;
-  /** Destination phone (E.164 or templated string like "{{userPhone}}"). */
-  phone_number: string;
-};
-
-export type ToolNode = BaseNode & {
-  type: "tool";
-  name: string;
-  text: string;
-};
-
-export type QuestionsListNode = BaseNode & {
-  type: "questionsList";
-  questions: Question[];
-};
-
-export type EndNode = BaseNode & { type: "end" };
-
-export type Interaction =
-  | StartNode
-  | SayNode
-  | ConditionNode
-  | ImproviseNode
-  | ToolNode
-  | SendMessageNode
-  | QuestionsListNode
-  | EndNode;
-
-export type Edge = {
-  id: string;
-  source: string;
-  target: string;
-  label?: string | null;
-};
-
-export type MetaKey = {
-  key: string;
-  required?: boolean;
-};
-
-export type UserProperty = {
-  name: string;
-  description: string;
-};
-
-export type InterruptionSettings = {
-  enableInterruptionDetection?: boolean;
-  interruptionWindowSeconds?: number;
-  interruptionThresholdSeconds?: number;
-  interruptionInstruction?: string;
-};
-
-export type SilenceEscalationSettings = {
-  enableSilenceDetection?: boolean;
-  firstWarningSilenceSeconds?: number;
-  firstWarningInstruction?: string;
-  secondWarningSilenceSeconds?: number;
-  secondWarningInstruction?: string;
-  disconnectSilenceSeconds?: number;
-  silenceTimeoutSeconds?: number;
-};
-
-export type ConversationSettings = {
-  interruptions?: InterruptionSettings;
-  silence?: SilenceEscalationSettings;
-  liveTimeUpdates?: boolean;
-};
-
-/* ----------  The Flow object ---------- */
-
-export type Flow = {
-  freeTextContent?: string;
-  isFreeText?: boolean;
-  disableGenericPrompt?: boolean;
-  _id?: ObjectId;
-
-  flowName: string;
-  clientId: string;
-
-  systemInstructions: string;
-  initialSentence: string;
-  voice?: string;
-
-  insights: string[];
-  conversationSettings?: ConversationSettings;
-
-  interactions: Interaction[];
-
-  edges?: Edge[] | null;
-  metaKeys?: MetaKey[] | null;
-  userProperties?: UserProperty[] | null;
-  tools?: FlowTool[];
-  afterCallEvent?: string;
-
-  products?: string[];
-
-  // AI provider configuration
-  aiProvider?: any;
-
-  // Timestamps
-  createdAt?: Date;
-  updatedAt?: Date;
-};
+import { ObjectId } from "mongodb";
+
+/* ----------  Basic helpers  ---------- */
+
+export type Position = { x: number; y: number };
+export type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+
+export type QuestionType = "open" | "multiple" | "table";
+export type SelectionType = "single" | "multiple";
+
+export type Question = {
+  id: string;
+  type: QuestionType;
+  text: string;
+  repeatAnswer?: boolean;
+  // For 'multiple' type questions:
+  answers?: string[] | null;
+  selectionType?: SelectionType | null; // 'single' = choose one, 'multiple' = choose one or more
+  // For 'table' type questions:
+  tableHeader?: string | null;
+  tableRows?: string[] | null;
+  tableColumns?: string[] | null; // These are the answer options shared across all rows
+  // Note: 'table' questions can also have selectionType to indicate if each row allows single or multiple selections
+};
+
+export type NodeKind =
+  | "start"
+  | "say"
+  | "condition"
+  | "improvise"
+  | "tool"
+  | "sendMessage"
+  | "questionsList"
+  | "end";
+type BaseNode = {
+  id: string;
+  type: NodeKind;
+  text: string;
+
+  name?: string | null;
+  position: Position;
+  children?: string[] | null;
+  successStatus?: string | null;
+  questions?: Question[] | null;
+};
+
+export type StartNode = BaseNode & { type: "start" };
+
+export type SayNode = BaseNode & { type: "say" };
+
+export type ConditionNode = BaseNode & {
+  type: "condition";
+  conditions: Array<{
+    conditionString: string;
+    nodeType?: string | null;
+    id?: string | null;
+  }>;
+  defaultNodeType?: string | null;
+  defaultChild?: { id?: string } | null;
+};
+
+export type ImproviseNode = BaseNode & { type: "improvise" };
+
+export type FlowTool = {
+  id: string;
+  name: string;
+  description?: string;
+  url: string;
+  method: HttpMethod;
+  headers?: Record<string, string>;
+  parameters: Record<string, unknown>;
+  bodyFormat?: "json" | "form-data";
+  preventAudioDuringTool?: boolean;
+  /** When true, prefer cached transcription from Redis (default: false). */
+  useRedisTranscription?: boolean;
+  sendUserAuthToken?: boolean;
+  runInBackground?: boolean;
+  backgroundToolType?: "backgroundToolAlways" | "backgroundToolOnce";
+  backgroundContinuationInstructions?: string;
+};
+
+export type SendMethod = "sms" | "whatsapp";
+
+export type SendMessageNode = BaseNode & {
+  type: "sendMessage";
+  /** Which channel to use. If omitted, decide at runtime (e.g., default to whatsapp). */
+  send_method: SendMethod;
+  /** Destination phone (E.164 or templated string like "{{userPhone}}"). */
+  phone_number: string;
+};
+
+export type ToolNode = BaseNode & {
+  type: "tool";
+  name: string;
+  text: string;
+};
+
+export type QuestionsListNode = BaseNode & {
+  type: "questionsList";
+  questions: Question[];
+};
+
+export type EndNode = BaseNode & { type: "end" };
+
+export type Interaction =
+  | StartNode
+  | SayNode
+  | ConditionNode
+  | ImproviseNode
+  | ToolNode
+  | SendMessageNode
+  | QuestionsListNode
+  | EndNode;
+
+export type Edge = {
+  id: string;
+  source: string;
+  target: string;
+  label?: string | null;
+};
+
+export type MetaKey = {
+  key: string;
+  required?: boolean;
+};
+
+export type UserProperty = {
+  name: string;
+  description: string;
+};
+
+export type InterruptionSettings = {
+  enableInterruptionDetection?: boolean;
+  interruptionWindowSeconds?: number;
+  interruptionThresholdSeconds?: number;
+  interruptionInstruction?: string;
+};
+
+export type SilenceEscalationSettings = {
+  enableSilenceDetection?: boolean;
+  firstWarningSilenceSeconds?: number;
+  firstWarningInstruction?: string;
+  secondWarningSilenceSeconds?: number;
+  secondWarningInstruction?: string;
+  disconnectSilenceSeconds?: number;
+  silenceTimeoutSeconds?: number;
+};
+
+export type ConversationSettings = {
+  interruptions?: InterruptionSettings;
+  silence?: SilenceEscalationSettings;
+  liveTimeUpdates?: boolean;
+};
+
+/* ----------  Internal tools ---------- */
+
+export type InternalToolParamConfig = {
+  description?: string;
+  /** Pinned value. When set, the agent is not asked for this parameter. */
+  value?: string | number | boolean | string[];
+};
+
+export type InternalToolConfig = {
+  enabled: boolean;
+  /** Max invocations per call. Unlimited when omitted. */
+  maxCalls?: number;
+  params?: Record<string, InternalToolParamConfig>;
+};
+
+/* ----------  The Flow object ---------- */
+
+export type Flow = {
+  freeTextContent?: string;
+  isFreeText?: boolean;
+  disableGenericPrompt?: boolean;
+  _id?: ObjectId;
+
+  flowName: string;
+  clientId: string;
+
+  systemInstructions: string;
+  initialSentence: string;
+  voice?: string;
+
+  insights: string[];
+  conversationSettings?: ConversationSettings;
+
+  interactions: Interaction[];
+
+  edges?: Edge[] | null;
+  metaKeys?: MetaKey[] | null;
+  userProperties?: UserProperty[] | null;
+  tools?: FlowTool[];
+  afterCallEvent?: string;
+
+  products?: string[];
+
+  // AI provider configuration
+  aiProvider?: any;
+
+  /** Internal tool toggles and per-parameter overrides, keyed by tool name. */
+  internalTools?: Record<string, InternalToolConfig>;
+
+  // Timestamps
+  createdAt?: Date;
+  updatedAt?: Date;
+};
+
+export type FlowUpdateParams = Partial<
+  Omit<Flow, "_id" | "clientId" | "createdAt">
+>;

package/src/talkpilot/flows/index.ts

@@ -1,2 +1,7 @@
-export { getFlowsCollection, findFlowById } from "./flows.getter";
-export type * from "./flows.types";
+export {
+  getFlowsCollection,
+  findFlowById,
+  createFlow,
+  updateFlowById,
+} from "./flows.getter";
+export type * from "./flows.types";

package/src/talkpilot/groups/__tests__/groups.spec.ts

@@ -1,90 +1,90 @@
-import { ObjectId } from "mongodb";
-import { faker } from "@faker-js/faker";
-import {
-  getGroupsCollection,
-  findGroups,
-  createGroup,
-  updateGroup,
-  removeGroup,
-} from "../groups.getters";
-import { createGroup as createGroupDoc } from "../../../test-utils/factories";
-
-describe("db.groups", () => {
-  describe("getGroupsCollection", () => {
-    it('returns the "groups" collection', () => {
-      expect(getGroupsCollection().collectionName).toBe("groups");
-    });
-  });
-
-  describe("findGroups", () => {
-    it("returns groups matching the provided filter", async () => {
-      const clientId = faker.string.uuid();
-      const g1 = createGroupDoc({ clientId, name: "Group A" });
-      const g2 = createGroupDoc({ clientId, name: "Group B" });
-      const gOther = createGroupDoc({
-        clientId: faker.string.uuid(),
-        name: "Group C",
-      });
-
-      await getGroupsCollection().insertMany([g1, g2, gOther]);
-
-      const result = await findGroups({ clientId });
-      const names = result.map((g) => g.name).sort();
-
-      expect(result).toHaveLength(2);
-      expect(names).toEqual(["Group A", "Group B"]);
-    });
-  });
-
-  describe("createGroup", () => {
-    it("inserts a group and returns insertedId", async () => {
-      const toInsert = createGroupDoc({ name: "New Group" });
-
-      const insertedId = await createGroup(toInsert);
-      expect(insertedId).toBeInstanceOf(ObjectId);
-
-      const fromDb = await getGroupsCollection().findOne({ _id: insertedId });
-      expect(fromDb?.name).toBe("New Group");
-      expect(fromDb?.clientId).toBe(toInsert.clientId);
-    });
-  });
-
-  describe("updateGroup", () => {
-    it("updates the group and sets updatedAt, returning the updated document", async () => {
-      const original = createGroupDoc({
-        name: "Before",
-        description: "Old desc",
-      });
-      const { insertedId } = await getGroupsCollection().insertOne(original);
-      const before = await getGroupsCollection().findOne({ _id: insertedId });
-
-      // Add a small delay to ensure updatedAt will be different
-      await new Promise((resolve) => setTimeout(resolve, 10));
-
-      const res = await updateGroup(
-        { _id: insertedId },
-        { name: "After", description: "New desc" },
-      );
-
-      expect(res?._id).toEqual(insertedId);
-      expect(res?.name).toBe("After");
-      expect(res?.description).toBe("New desc");
-      expect(new Date(res!.updatedAt).getTime()).toBeGreaterThan(
-        new Date(before!.updatedAt).getTime(),
-      );
-    });
-  });
-
-  describe("removeGroup", () => {
-    it("removes a group by string id", async () => {
-      const { insertedId } =
-        await getGroupsCollection().insertOne(createGroupDoc());
-
-      const result = await removeGroup(insertedId.toHexString());
-      expect(result.deletedCount).toBe(1);
-
-      const check = await getGroupsCollection().findOne({ _id: insertedId });
-      expect(check).toBeNull();
-    });
-  });
-});
+import { ObjectId } from "mongodb";
+import { faker } from "@faker-js/faker";
+import {
+  getGroupsCollection,
+  findGroups,
+  createGroup,
+  updateGroup,
+  removeGroup,
+} from "../groups.getters";
+import { createGroup as createGroupDoc } from "../../../test-utils/factories";
+
+describe("db.groups", () => {
+  describe("getGroupsCollection", () => {
+    it('returns the "groups" collection', () => {
+      expect(getGroupsCollection().collectionName).toBe("groups");
+    });
+  });
+
+  describe("findGroups", () => {
+    it("returns groups matching the provided filter", async () => {
+      const clientId = faker.string.uuid();
+      const g1 = createGroupDoc({ clientId, name: "Group A" });
+      const g2 = createGroupDoc({ clientId, name: "Group B" });
+      const gOther = createGroupDoc({
+        clientId: faker.string.uuid(),
+        name: "Group C",
+      });
+
+      await getGroupsCollection().insertMany([g1, g2, gOther]);
+
+      const result = await findGroups({ clientId });
+      const names = result.map((g) => g.name).sort();
+
+      expect(result).toHaveLength(2);
+      expect(names).toEqual(["Group A", "Group B"]);
+    });
+  });
+
+  describe("createGroup", () => {
+    it("inserts a group and returns insertedId", async () => {
+      const toInsert = createGroupDoc({ name: "New Group" });
+
+      const insertedId = await createGroup(toInsert);
+      expect(insertedId).toBeInstanceOf(ObjectId);
+
+      const fromDb = await getGroupsCollection().findOne({ _id: insertedId });
+      expect(fromDb?.name).toBe("New Group");
+      expect(fromDb?.clientId).toBe(toInsert.clientId);
+    });
+  });
+
+  describe("updateGroup", () => {
+    it("updates the group and sets updatedAt, returning the updated document", async () => {
+      const original = createGroupDoc({
+        name: "Before",
+        description: "Old desc",
+      });
+      const { insertedId } = await getGroupsCollection().insertOne(original);
+      const before = await getGroupsCollection().findOne({ _id: insertedId });
+
+      // Add a small delay to ensure updatedAt will be different
+      await new Promise((resolve) => setTimeout(resolve, 10));
+
+      const res = await updateGroup(
+        { _id: insertedId },
+        { name: "After", description: "New desc" },
+      );
+
+      expect(res?._id).toEqual(insertedId);
+      expect(res?.name).toBe("After");
+      expect(res?.description).toBe("New desc");
+      expect(new Date(res!.updatedAt).getTime()).toBeGreaterThan(
+        new Date(before!.updatedAt).getTime(),
+      );
+    });
+  });
+
+  describe("removeGroup", () => {
+    it("removes a group by string id", async () => {
+      const { insertedId } =
+        await getGroupsCollection().insertOne(createGroupDoc());
+
+      const result = await removeGroup(insertedId.toHexString());
+      expect(result.deletedCount).toBe(1);
+
+      const check = await getGroupsCollection().findOne({ _id: insertedId });
+      expect(check).toBeNull();
+    });
+  });
+});

package/src/talkpilot/groups/__tests__/phone.utils.spec.ts

@@ -1,32 +1,32 @@
-import { enrichPhoneNumber, isValidE164 } from "../phone.utils";
-
-describe("Phone Utilities", () => {
-  describe("enrichPhoneNumber", () => {
-    it("should enrich Israeli number", () => {
-      const result = enrichPhoneNumber("+972507725874");
-      expect(result?.e164).toBe("+972507725874");
-      expect(result?.region).toBeDefined();
-      expect(result?.countryCallingCode).toBe("972");
-    });
-
-    it("should enrich US number", () => {
-      const result = enrichPhoneNumber("+12025551234");
-      expect(result?.region).toBe("US");
-      expect(result?.countryCallingCode).toBe("1");
-    });
-
-    it("should return null for invalid", () => {
-      expect(enrichPhoneNumber("invalid")).toBeNull();
-      expect(enrichPhoneNumber("0507725874")).toBeNull();
-    });
-  });
-
-  describe("isValidE164", () => {
-    it("should validate E.164 format", () => {
-      expect(isValidE164("+972508832983")).toBe(true);
-      expect(isValidE164("+12025551234")).toBe(true);
-      expect(isValidE164("0501234567")).toBe(false);
-      expect(isValidE164("invalid")).toBe(false);
-    });
-  });
-});
+import { enrichPhoneNumber, isValidE164 } from "../phone.utils";
+
+describe("Phone Utilities", () => {
+  describe("enrichPhoneNumber", () => {
+    it("should enrich Israeli number", () => {
+      const result = enrichPhoneNumber("+972507725874");
+      expect(result?.e164).toBe("+972507725874");
+      expect(result?.region).toBeDefined();
+      expect(result?.countryCallingCode).toBe("972");
+    });
+
+    it("should enrich US number", () => {
+      const result = enrichPhoneNumber("+12025551234");
+      expect(result?.region).toBe("US");
+      expect(result?.countryCallingCode).toBe("1");
+    });
+
+    it("should return null for invalid", () => {
+      expect(enrichPhoneNumber("invalid")).toBeNull();
+      expect(enrichPhoneNumber("0507725874")).toBeNull();
+    });
+  });
+
+  describe("isValidE164", () => {
+    it("should validate E.164 format", () => {
+      expect(isValidE164("+972508832983")).toBe(true);
+      expect(isValidE164("+12025551234")).toBe(true);
+      expect(isValidE164("0501234567")).toBe(false);
+      expect(isValidE164("invalid")).toBe(false);
+    });
+  });
+});