@talkpilot/core-db 1.2.0 → 1.2.2

package/src/talkpilot/flows/flows.schema.ts

@@ -1,153 +1,153 @@
-export const flowMongoSchema = {
-  bsonType: "object",
-  required: [
-    "flowName",
-    "systemInstructions",
-    "initialSentence",
-    "interactions",
-  ],
-  properties: {
-    _id: { bsonType: "objectId" },
-    flowName: { bsonType: "string" },
-    clientId: { bsonType: "string" },
-    systemInstructions: { bsonType: "string" },
-    initialSentence: { bsonType: "string" },
-    voice: { bsonType: ["string", "null"] },
-    conversationSettings: {
-      bsonType: ["object", "null"],
-      properties: {
-        interruptions: {
-          bsonType: ["object", "null"],
-          properties: {
-            enableInterruptionDetection: { bsonType: "bool" },
-            interruptionWindowSeconds: { bsonType: "number" },
-            interruptionThresholdSeconds: { bsonType: "number" },
-            interruptionInstruction: { bsonType: "string" },
-          },
-          additionalProperties: false,
-        },
-        silence: {
-          bsonType: ["object", "null"],
-          properties: {
-            enableSilenceDetection: { bsonType: "bool" },
-            firstWarningSilenceSeconds: { bsonType: "number" },
-            firstWarningInstruction: { bsonType: "string" },
-            secondWarningSilenceSeconds: { bsonType: "number" },
-            secondWarningInstruction: { bsonType: "string" },
-            disconnectSilenceSeconds: { bsonType: "number" },
-          },
-          additionalProperties: false,
-        },
-        liveTimeUpdates: { bsonType: "bool" },
-      },
-      additionalProperties: false,
-    },
-    interactions: {
-      bsonType: "array",
-      items: {
-        bsonType: "object",
-        required: ["id", "type", "text", "position"],
-        properties: {
-          id: { bsonType: "string" },
-          type: { bsonType: "string" },
-          text: { bsonType: "string" },
-          successStatus: { bsonType: ["string", "null"] },
-          conditions: {
-            bsonType: ["array", "null"],
-            items: {
-              bsonType: "object",
-              required: ["conditionString"],
-              properties: {
-                conditionString: { bsonType: "string" },
-                nodeType: { bsonType: ["string", "null"] },
-                id: { bsonType: ["string", "null"] },
-              },
-            },
-          },
-          defaultNodeType: { bsonType: ["string", "null"] },
-          defaultChild: {
-            bsonType: ["object", "null"],
-            properties: { id: { bsonType: "string" } },
-          },
-          position: {
-            bsonType: "object",
-            required: ["x", "y"],
-            properties: {
-              x: { bsonType: "number" },
-              y: { bsonType: "number" },
-            },
-          },
-          name: { bsonType: ["string", "null"] },
-          children: {
-            bsonType: ["array", "null"],
-            items: { bsonType: "string" },
-          },
-          resultsLabel: { bsonType: ["string", "null"] },
-          resultsColor: { bsonType: ["string", "null"] },
-        },
-      },
-    },
-    edges: {
-      bsonType: ["array", "null"],
-      items: {
-        bsonType: "object",
-        required: ["id", "source", "target"],
-        properties: {
-          id: { bsonType: "string" },
-          source: { bsonType: "string" },
-          target: { bsonType: "string" },
-          label: { bsonType: ["string", "null"] },
-        },
-      },
-    },
-    metaKeys: {
-      bsonType: ["array", "null"],
-      items: {
-        bsonType: "object",
-        required: ["key"],
-        properties: {
-          key: { bsonType: "string" },
-          required: { bsonType: "bool" },
-        },
-      },
-    },
-    userProperties: {
-      bsonType: ["array", "null"],
-      items: {
-        bsonType: "object",
-        required: ["name", "description"],
-        properties: {
-          name: { bsonType: "string" },
-          description: { bsonType: "string" },
-        },
-      },
-    },
-    tools: {
-      bsonType: ["array", "null"],
-      items: {
-        bsonType: "object",
-        required: ["id", "name", "url", "method", "parameters"],
-        properties: {
-          id: { bsonType: "string" },
-          name: { bsonType: "string" },
-          description: { bsonType: "string" },
-          url: { bsonType: "string" },
-          method: { bsonType: "string" },
-          headers: { bsonType: "object" },
-          parameters: { bsonType: "object" },
-          bodyFormat: { bsonType: "string", enum: ["json", "form-data"] },
-          preventAudioDuringTool: { bsonType: "bool" },
-          sendUserAuthToken: { bsonType: "bool" },
-          runInBackground: { bsonType: "bool" },
-          backgroundToolType: {
-            bsonType: "string",
-            enum: ["backgroundToolAlways", "backgroundToolOnce"],
-          },
-          backgroundContinuationInstructions: { bsonType: 'string' },
-        },
-        additionalProperties: false,
-      },
-    },
-  },
-  additionalProperties: false,
-} as const;
+export const flowMongoSchema = {
+  bsonType: "object",
+  required: [
+    "flowName",
+    "systemInstructions",
+    "initialSentence",
+    "interactions",
+  ],
+  properties: {
+    _id: { bsonType: "objectId" },
+    flowName: { bsonType: "string" },
+    clientId: { bsonType: "string" },
+    systemInstructions: { bsonType: "string" },
+    initialSentence: { bsonType: "string" },
+    voice: { bsonType: ["string", "null"] },
+    conversationSettings: {
+      bsonType: ["object", "null"],
+      properties: {
+        interruptions: {
+          bsonType: ["object", "null"],
+          properties: {
+            enableInterruptionDetection: { bsonType: "bool" },
+            interruptionWindowSeconds: { bsonType: "number" },
+            interruptionThresholdSeconds: { bsonType: "number" },
+            interruptionInstruction: { bsonType: "string" },
+          },
+          additionalProperties: false,
+        },
+        silence: {
+          bsonType: ["object", "null"],
+          properties: {
+            enableSilenceDetection: { bsonType: "bool" },
+            firstWarningSilenceSeconds: { bsonType: "number" },
+            firstWarningInstruction: { bsonType: "string" },
+            secondWarningSilenceSeconds: { bsonType: "number" },
+            secondWarningInstruction: { bsonType: "string" },
+            disconnectSilenceSeconds: { bsonType: "number" },
+          },
+          additionalProperties: false,
+        },
+        liveTimeUpdates: { bsonType: "bool" },
+      },
+      additionalProperties: false,
+    },
+    interactions: {
+      bsonType: "array",
+      items: {
+        bsonType: "object",
+        required: ["id", "type", "text", "position"],
+        properties: {
+          id: { bsonType: "string" },
+          type: { bsonType: "string" },
+          text: { bsonType: "string" },
+          successStatus: { bsonType: ["string", "null"] },
+          conditions: {
+            bsonType: ["array", "null"],
+            items: {
+              bsonType: "object",
+              required: ["conditionString"],
+              properties: {
+                conditionString: { bsonType: "string" },
+                nodeType: { bsonType: ["string", "null"] },
+                id: { bsonType: ["string", "null"] },
+              },
+            },
+          },
+          defaultNodeType: { bsonType: ["string", "null"] },
+          defaultChild: {
+            bsonType: ["object", "null"],
+            properties: { id: { bsonType: "string" } },
+          },
+          position: {
+            bsonType: "object",
+            required: ["x", "y"],
+            properties: {
+              x: { bsonType: "number" },
+              y: { bsonType: "number" },
+            },
+          },
+          name: { bsonType: ["string", "null"] },
+          children: {
+            bsonType: ["array", "null"],
+            items: { bsonType: "string" },
+          },
+          resultsLabel: { bsonType: ["string", "null"] },
+          resultsColor: { bsonType: ["string", "null"] },
+        },
+      },
+    },
+    edges: {
+      bsonType: ["array", "null"],
+      items: {
+        bsonType: "object",
+        required: ["id", "source", "target"],
+        properties: {
+          id: { bsonType: "string" },
+          source: { bsonType: "string" },
+          target: { bsonType: "string" },
+          label: { bsonType: ["string", "null"] },
+        },
+      },
+    },
+    metaKeys: {
+      bsonType: ["array", "null"],
+      items: {
+        bsonType: "object",
+        required: ["key"],
+        properties: {
+          key: { bsonType: "string" },
+          required: { bsonType: "bool" },
+        },
+      },
+    },
+    userProperties: {
+      bsonType: ["array", "null"],
+      items: {
+        bsonType: "object",
+        required: ["name", "description"],
+        properties: {
+          name: { bsonType: "string" },
+          description: { bsonType: "string" },
+        },
+      },
+    },
+    tools: {
+      bsonType: ["array", "null"],
+      items: {
+        bsonType: "object",
+        required: ["id", "name", "url", "method", "parameters"],
+        properties: {
+          id: { bsonType: "string" },
+          name: { bsonType: "string" },
+          description: { bsonType: "string" },
+          url: { bsonType: "string" },
+          method: { bsonType: "string" },
+          headers: { bsonType: "object" },
+          parameters: { bsonType: "object" },
+          bodyFormat: { bsonType: "string", enum: ["json", "form-data"] },
+          preventAudioDuringTool: { bsonType: "bool" },
+          sendUserAuthToken: { bsonType: "bool" },
+          runInBackground: { bsonType: "bool" },
+          backgroundToolType: {
+            bsonType: "string",
+            enum: ["backgroundToolAlways", "backgroundToolOnce"],
+          },
+          backgroundContinuationInstructions: { bsonType: "string" },
+        },
+        additionalProperties: false,
+      },
+    },
+  },
+  additionalProperties: false,
+} as const;

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

@@ -1,184 +1,184 @@
-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;
-  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;
-  _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;
-
-  // 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;
+  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;
+  _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;
+
+  // AI provider configuration
+  aiProvider?: any;
+
+  // Timestamps
+  createdAt?: Date;
+  updatedAt?: Date;
+};