@talkpilot/core-db 1.1.18 → 1.2.0

package/src/talkpilot/clientsConfig/clientsConfig.types.ts

@@ -1,92 +1,94 @@
-import { WithId } from "mongodb";
-
-export type InitiateCallForShortSlaConfig = {
-  active: boolean;
-  max_hours: number;
-  contacts?: { name: string; phoneNumber: string }[];
-  flow_id?: string | string[];
-};
-
-export type Moked106Config = {
-  initiate_call_for_short_sla?: InitiateCallForShortSlaConfig;
-  avoidSaveTickets?: boolean;
-  withUploadImagesSms?: boolean;
-  withNeedAttentionCalls?: boolean;
-};
-
-export type MunicipalProduct = {
-  moked_106?: Moked106Config;
-  cityName: string;
-  crmName?: string;
-  cityDisplayName?: string;
-  cityLogoURL?: string;
-  timezone: string;
-  websiteUrl?: string;
-  isProductionReady?: boolean;
-  municipalDisplayName?: string;
-};
-
-export type WebsiteTalkScheduler = {
-  type: "cron";
-  schedule: string;
-};
-
-export type WebsiteTalkProduct = {
-  logoUrl: string;
-  companyName: string;
-  timezone: string;
-  language: string;
-  defaultBaseUrl: string;
-  scheduler?: WebsiteTalkScheduler;
-};
-
-export type Products = {
-  municipal?: MunicipalProduct;
-  clinics?: ClinicsProduct;
-  websiteTalk?: WebsiteTalkProduct;
-  [key: string]: unknown;
-};
-
-export type ClinicsProduct = {
-  api_key_secret_name: string;
-  base_api_url: string;
-  provider: "clinix" | (string & {});
-  description?: string;
-};
-
-export type ClientLanguageName =
-  | "Hebrew"
-  | "English"
-  | "Russian"
-  | "French"
-  | "Spanish"
-  | (string & {});
-
-export type SendGridConfig = {
-  emailTo: string[];
-  templateId?: string;
-  senderId?: string;
-};
-
-export type SmsConfig = {};
-
-export type WhatsappConfig = {};
-
-export type CommunicationsConfig = {
-  sendGrid?: SendGridConfig;
-  sms?: SmsConfig;
-  whatsapp?: WhatsappConfig;
-};
-
-export type ClientConfig<P extends Products = Products> = {
-  clientId: string;
-  phoneNumber?: string;
-  language?: ClientLanguageName;
-  products: P;
-  timezone?: string;
-  communications?: CommunicationsConfig;
-};
-
-export type ClientConfigDoc<P extends Products = Products> = WithId<
-  ClientConfig<P>
->;
+import { WithId } from "mongodb";
+
+export type InitiateCallForShortSlaConfig = {
+  active: boolean;
+  max_hours: number;
+  contacts?: { name: string; phoneNumber: string }[];
+  flow_id?: string | string[];
+};
+
+export type Moked106Config = {
+  initiate_call_for_short_sla?: InitiateCallForShortSlaConfig;
+  avoidSaveTickets?: boolean;
+  withUploadImagesSms?: boolean;
+  withNeedAttentionCalls?: boolean;
+};
+
+export type MunicipalProduct = {
+  moked_106?: Moked106Config;
+  cityName: string;
+  crmName?: string;
+  cityDisplayName?: string;
+  cityLogoURL?: string;
+  timezone: string;
+  websiteUrl?: string;
+  isProductionReady?: boolean;
+  municipalDisplayName?: string;
+  findSubjectsSystemPrompt?: string;
+  findStreetsSystemPrompt?: string;
+};
+
+export type WebsiteTalkScheduler = {
+  type: "cron";
+  schedule: string;
+};
+
+export type WebsiteTalkProduct = {
+  logoUrl: string;
+  companyName: string;
+  timezone: string;
+  language: string;
+  defaultBaseUrl: string;
+  scheduler?: WebsiteTalkScheduler;
+};
+
+export type Products = {
+  municipal?: MunicipalProduct;
+  clinics?: ClinicsProduct;
+  websiteTalk?: WebsiteTalkProduct;
+  [key: string]: unknown;
+};
+
+export type ClinicsProduct = {
+  api_key_secret_name: string;
+  base_api_url: string;
+  provider: "clinix" | (string & {});
+  description?: string;
+};
+
+export type ClientLanguageName =
+  | "Hebrew"
+  | "English"
+  | "Russian"
+  | "French"
+  | "Spanish"
+  | (string & {});
+
+export type SendGridConfig = {
+  emailTo: string[];
+  templateId?: string;
+  senderId?: string;
+};
+
+export type SmsConfig = {};
+
+export type WhatsappConfig = {};
+
+export type CommunicationsConfig = {
+  sendGrid?: SendGridConfig;
+  sms?: SmsConfig;
+  whatsapp?: WhatsappConfig;
+};
+
+export type ClientConfig<P extends Products = Products> = {
+  clientId: string;
+  phoneNumber?: string;
+  language?: ClientLanguageName;
+  products: P;
+  timezone?: string;
+  communications?: CommunicationsConfig;
+};
+
+export type ClientConfigDoc<P extends Products = Products> = WithId<
+  ClientConfig<P>
+>;

package/src/talkpilot/clientsConfig/index.ts

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

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

@@ -1,67 +1,67 @@
-import { flowMongoSchema } from "../flows.schema";
-
-describe("flowMongoSchema", () => {
-  it("defines conversationSettings as optional object or null", () => {
-    const schema: any = flowMongoSchema;
-
-    expect(schema.properties).toHaveProperty("conversationSettings");
-    expect(schema.properties.conversationSettings.bsonType).toEqual([
-      "object",
-      "null",
-    ]);
-    expect(schema.required).not.toContain("conversationSettings");
-    expect(schema.additionalProperties).toBe(false);
-  });
-
-  it("defines conversationSettings with expected nested properties", () => {
-    const schema: any = flowMongoSchema;
-    const convSettings = schema.properties.conversationSettings.properties;
-
-    expect(convSettings).toHaveProperty("interruptions");
-    expect(convSettings.interruptions.bsonType).toEqual(["object", "null"]);
-
-    const interruptions = convSettings.interruptions.properties;
-    expect(interruptions.enableInterruptionDetection.bsonType).toEqual("bool");
-    expect(interruptions.interruptionWindowSeconds.bsonType).toEqual("number");
-    expect(interruptions.interruptionThresholdSeconds.bsonType).toEqual(
-      "number",
-    );
-    expect(interruptions.interruptionInstruction.bsonType).toEqual("string");
-
-    expect(convSettings).toHaveProperty("silence");
-    expect(convSettings.silence.bsonType).toEqual(["object", "null"]);
-
-    const silence = convSettings.silence.properties;
-    expect(silence.enableSilenceDetection.bsonType).toEqual("bool");
-    expect(silence.firstWarningSilenceSeconds.bsonType).toEqual("number");
-    expect(silence.firstWarningInstruction.bsonType).toEqual("string");
-    expect(silence.secondWarningSilenceSeconds.bsonType).toEqual("number");
-    expect(silence.secondWarningInstruction.bsonType).toEqual("string");
-    expect(silence.disconnectSilenceSeconds.bsonType).toEqual("number");
-    expect(convSettings).toHaveProperty("liveTimeUpdates");
-    expect(convSettings.liveTimeUpdates.bsonType).toEqual("bool");
-  });
-
-  it("should define tools schema and return a backgroundToolType enum with allowed values", () => {
-    const schema: any = flowMongoSchema;
-
-    expect(schema.properties).toHaveProperty("tools");
-    expect(schema.properties.tools.bsonType).toEqual(["array", "null"]);
-
-    const toolItem = schema.properties.tools.items;
-    expect(toolItem.bsonType).toBe("object");
-
-    expect(toolItem.properties).toHaveProperty("runInBackground");
-    expect(toolItem.properties.runInBackground.bsonType).toBe("bool");
-
-    expect(toolItem.properties).toHaveProperty("backgroundToolType");
-    expect(toolItem.properties.backgroundToolType.bsonType).toBe("string");
-    expect(toolItem.properties.backgroundToolType.enum).toEqual([
-      "backgroundToolAlways",
-      "backgroundToolOnce",
-    ]);
-
-    expect(toolItem.properties).toHaveProperty('backgroundContinuationInstructions');
-    expect(toolItem.properties.backgroundContinuationInstructions.bsonType).toBe('string');
-  });
-});
+import { flowMongoSchema } from "../flows.schema";
+
+describe("flowMongoSchema", () => {
+  it("defines conversationSettings as optional object or null", () => {
+    const schema: any = flowMongoSchema;
+
+    expect(schema.properties).toHaveProperty("conversationSettings");
+    expect(schema.properties.conversationSettings.bsonType).toEqual([
+      "object",
+      "null",
+    ]);
+    expect(schema.required).not.toContain("conversationSettings");
+    expect(schema.additionalProperties).toBe(false);
+  });
+
+  it("defines conversationSettings with expected nested properties", () => {
+    const schema: any = flowMongoSchema;
+    const convSettings = schema.properties.conversationSettings.properties;
+
+    expect(convSettings).toHaveProperty("interruptions");
+    expect(convSettings.interruptions.bsonType).toEqual(["object", "null"]);
+
+    const interruptions = convSettings.interruptions.properties;
+    expect(interruptions.enableInterruptionDetection.bsonType).toEqual("bool");
+    expect(interruptions.interruptionWindowSeconds.bsonType).toEqual("number");
+    expect(interruptions.interruptionThresholdSeconds.bsonType).toEqual(
+      "number",
+    );
+    expect(interruptions.interruptionInstruction.bsonType).toEqual("string");
+
+    expect(convSettings).toHaveProperty("silence");
+    expect(convSettings.silence.bsonType).toEqual(["object", "null"]);
+
+    const silence = convSettings.silence.properties;
+    expect(silence.enableSilenceDetection.bsonType).toEqual("bool");
+    expect(silence.firstWarningSilenceSeconds.bsonType).toEqual("number");
+    expect(silence.firstWarningInstruction.bsonType).toEqual("string");
+    expect(silence.secondWarningSilenceSeconds.bsonType).toEqual("number");
+    expect(silence.secondWarningInstruction.bsonType).toEqual("string");
+    expect(silence.disconnectSilenceSeconds.bsonType).toEqual("number");
+    expect(convSettings).toHaveProperty("liveTimeUpdates");
+    expect(convSettings.liveTimeUpdates.bsonType).toEqual("bool");
+  });
+
+  it("should define tools schema and return a backgroundToolType enum with allowed values", () => {
+    const schema: any = flowMongoSchema;
+
+    expect(schema.properties).toHaveProperty("tools");
+    expect(schema.properties.tools.bsonType).toEqual(["array", "null"]);
+
+    const toolItem = schema.properties.tools.items;
+    expect(toolItem.bsonType).toBe("object");
+
+    expect(toolItem.properties).toHaveProperty("runInBackground");
+    expect(toolItem.properties.runInBackground.bsonType).toBe("bool");
+
+    expect(toolItem.properties).toHaveProperty("backgroundToolType");
+    expect(toolItem.properties.backgroundToolType.bsonType).toBe("string");
+    expect(toolItem.properties.backgroundToolType.enum).toEqual([
+      "backgroundToolAlways",
+      "backgroundToolOnce",
+    ]);
+
+    expect(toolItem.properties).toHaveProperty('backgroundContinuationInstructions');
+    expect(toolItem.properties.backgroundContinuationInstructions.bsonType).toBe('string');
+  });
+});

package/src/talkpilot/flows/flows.getter.ts

@@ -1,14 +1,14 @@
-import type { Collection, ObjectId, WithId } from "mongodb";
-import { getDb } from "../index";
-import type { Flow } from "./flows.types";
-
-export const getFlowsCollection = (): Collection<Flow> => {
-  return getDb().collection<Flow>("flows");
-};
-
-export const findFlowById = (
-  flowId: ObjectId,
-  clientId: string,
-): Promise<WithId<Flow> | null> => {
-  return getFlowsCollection().findOne({ _id: flowId, clientId });
-};
+import type { Collection, ObjectId, WithId } from "mongodb";
+import { getDb } from "../index";
+import type { Flow } from "./flows.types";
+
+export const getFlowsCollection = (): Collection<Flow> => {
+  return getDb().collection<Flow>("flows");
+};
+
+export const findFlowById = (
+  flowId: ObjectId,
+  clientId: string,
+): Promise<WithId<Flow> | null> => {
+  return getFlowsCollection().findOne({ _id: flowId, clientId });
+};

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;