@talkpilot/core-db 1.3.83 → 1.3.85

package/src/municipal/departmentsSubjects/departmentsSubjects.types.ts

@@ -1,73 +1,73 @@
-import { ObjectId, WithId } from "mongodb";
-import { Request } from "express";
-import { ClientConfigDoc, Products } from "../../talkpilot";
-import { CityName } from "../utils/types";
-
-export type DepartmentSubject = {
-  _id: ObjectId;
-  createdAt: Date;
-  updatedAt: Date;
-  subjectName: string; // e.g. "אחזקה- איטום"
-  subject_id: string; // e.g. "6121"
-  sub_subject_name: string; // e.g. "איטום"
-  sub_subject_id: string; // e.g. "6123"
-  sub_subject_name2?: string; // e.g. "ניקיון באגם" (level 3 - grandchild)
-  sub_subject_id2?: string; // e.g. "2898" (level 3 - grandchild)
-  descriptions: string[]; // array of guideline / example descriptions
-  embedding_text?: string; // the text used to create the embedding
-  embedding?: number[]; // length should match embedding_dims (e.g. 1536)
-  embedding_model?: string; // e.g. "text-embedding-3-small"
-  embedding_dims?: number; // e.g. 1536
-  cityName: CityName;
-  guidelines?: string | null;
-  instructions?: Instruction[];
-  communications?: Communication[];
-  sla?: number;
-  isActive?: boolean;
-};
-
-export interface Instruction {
-  id: number;
-  instruction: string;
-}
-
-export interface Communication {
-  id: number;
-  type: CommunicationType;
-  message_text?: string;
-  template_id?: string;
-  to?: string;
-  is_deleted?: boolean;
-}
-
-export type DepartmentSubjectDoc = WithId<DepartmentSubject>;
-
-/**
- * Vector search result from MongoDB
- */
-export type VectorSearchResult = {
-  subjectName: string;
-  subject_id: number;
-  sub_subject_id: string;
-  sub_subject_id2?: string | null;
-  sub_subject_name: string;
-  sub_subject_name2?: string | null;
-  descriptions?: string[];
-  guidelines?: string | null;
-  instructions?: string | null;
-  score?: number;
-};
-
-export type CommunicationType = "free_text_sms" | "upload_url_sms";
-
-/**
- * Extended Express Request type with client configuration
- */
-export type RequestWithClientConfig = Request & {
-  uid: string;
-  clientConfig: ClientConfigDoc<Products>;
-  isGuest: boolean;
-  claims: Record<string, unknown>;
-  crmName?: string;
-  callSid?: string;
-};
+import { ObjectId, WithId } from "mongodb";
+import { Request } from "express";
+import { ClientConfigDoc, Products } from "../../talkpilot";
+import { CityName } from "../utils/types";
+
+export type DepartmentSubject = {
+  _id: ObjectId;
+  createdAt: Date;
+  updatedAt: Date;
+  subjectName: string; // e.g. "אחזקה- איטום"
+  subject_id: string; // e.g. "6121"
+  sub_subject_name: string; // e.g. "איטום"
+  sub_subject_id: string; // e.g. "6123"
+  sub_subject_name2?: string; // e.g. "ניקיון באגם" (level 3 - grandchild)
+  sub_subject_id2?: string; // e.g. "2898" (level 3 - grandchild)
+  descriptions: string[]; // array of guideline / example descriptions
+  embedding_text?: string; // the text used to create the embedding
+  embedding?: number[]; // length should match embedding_dims (e.g. 1536)
+  embedding_model?: string; // e.g. "text-embedding-3-small"
+  embedding_dims?: number; // e.g. 1536
+  cityName: CityName;
+  guidelines?: string | null;
+  instructions?: Instruction[];
+  communications?: Communication[];
+  sla?: number;
+  isActive?: boolean;
+};
+
+export interface Instruction {
+  id: number;
+  instruction: string;
+}
+
+export interface Communication {
+  id: number;
+  type: CommunicationType;
+  message_text?: string;
+  template_id?: string;
+  to?: string;
+  is_deleted?: boolean;
+}
+
+export type DepartmentSubjectDoc = WithId<DepartmentSubject>;
+
+/**
+ * Vector search result from MongoDB
+ */
+export type VectorSearchResult = {
+  subjectName: string;
+  subject_id: number;
+  sub_subject_id: string;
+  sub_subject_id2?: string | null;
+  sub_subject_name: string;
+  sub_subject_name2?: string | null;
+  descriptions?: string[];
+  guidelines?: string | null;
+  instructions?: string | null;
+  score?: number;
+};
+
+export type CommunicationType = "free_text_sms" | "upload_url_sms";
+
+/**
+ * Extended Express Request type with client configuration
+ */
+export type RequestWithClientConfig = Request & {
+  uid: string;
+  clientConfig: ClientConfigDoc<Products>;
+  isGuest: boolean;
+  claims: Record<string, unknown>;
+  crmName?: string;
+  callSid?: string;
+};

package/src/municipal/departmentsSubjects/index.ts

@@ -1,9 +1,9 @@
-export * from "./departmentsSubjects.getters";
-export type {
-  DepartmentSubject,
-  DepartmentSubjectDoc,
-  VectorSearchResult,
-  RequestWithClientConfig,
-  Communication,
-  Instruction,
-} from "./departmentsSubjects.types";
+export * from "./departmentsSubjects.getters";
+export type {
+  DepartmentSubject,
+  DepartmentSubjectDoc,
+  VectorSearchResult,
+  RequestWithClientConfig,
+  Communication,
+  Instruction,
+} from "./departmentsSubjects.types";

package/src/municipal/index.ts

@@ -1,23 +1,23 @@
-import { Db, ObjectId as MongoObjectId } from "mongodb";
-
-export * from "./cities";
-export * from "./streets";
-export * from "./departmentsSubjects";
-export * from "./tickets";
-export * from "./systemInstructions";
-export * from "./muniIssues";
-export * from "./residents";
-export * from "./utils/types";
-export type { CityName } from "./utils/types";
-export { municipalDataMongodbClient } from "./mongodb-client";
-
-let db: Db;
-export const setDb = (d: Db) => {
-  db = d;
-};
-
-export const getDb = (): Db => {
-  if (!db) throw new Error("Municipal Data DB not initialised");
-  return db;
-};
-export const ObjectId = MongoObjectId;
+import { Db, ObjectId as MongoObjectId } from "mongodb";
+
+export * from "./cities";
+export * from "./streets";
+export * from "./departmentsSubjects";
+export * from "./tickets";
+export * from "./systemInstructions";
+export * from "./muniIssues";
+export * from "./residents";
+export * from "./utils/types";
+export type { CityName } from "./utils/types";
+export { municipalDataMongodbClient } from "./mongodb-client";
+
+let db: Db;
+export const setDb = (d: Db) => {
+  db = d;
+};
+
+export const getDb = (): Db => {
+  if (!db) throw new Error("Municipal Data DB not initialised");
+  return db;
+};
+export const ObjectId = MongoObjectId;

package/src/municipal/mongodb-client.ts

@@ -1,61 +1,61 @@
-import { MongoClient, Db } from "mongodb";
-import { setDb } from "./index";
-import { validateConfig, validateMongoUri } from "../utils/validation";
-
-class MunicipalDataMongoDBClient {
-  private client: MongoClient | null = null;
-  private db: Db | null = null;
-  private readonly defaultDbName = "municipal-data";
-
-  async connect(uri?: string, dbName?: string): Promise<void> {
-    if (this.client) {
-      return;
-    }
-
-    const mongodbUri = uri || process.env.MONGO_URI || process.env.MONGODB_URI;
-    validateConfig("MONGO_URI", mongodbUri);
-    validateMongoUri(mongodbUri!);
-
-    try {
-      this.client = new MongoClient(mongodbUri!);
-      await this.client.connect();
-      const targetDbName =
-        dbName || process.env.MUNICIPAL_DB_NAME || this.defaultDbName;
-      this.db = this.client.db(targetDbName);
-      setDb(this.db);
-      console.info(`[core-db] Municipal MongoDB connected: ${targetDbName}`);
-    } catch (error) {
-      console.error("[core-db] Municipal connection failed", error);
-      throw error;
-    }
-  }
-
-  async disconnect(): Promise<void> {
-    if (this.client) {
-      try {
-        await this.client.close();
-        this.client = null;
-        this.db = null;
-        console.info("Municipal Data MongoDB disconnected successfully");
-      } catch (error) {
-        console.error("[core-db] Municipal disconnection failed", error);
-        throw error;
-      }
-    }
-  }
-
-  getDb(): Db {
-    if (!this.db) {
-      throw new Error(
-        "Municipal Data database not initialized. Call connect() first.",
-      );
-    }
-    return this.db;
-  }
-
-  isConnected(): boolean {
-    return this.client !== null && this.client !== undefined;
-  }
-}
-
-export const municipalDataMongodbClient = new MunicipalDataMongoDBClient();
+import { MongoClient, Db } from "mongodb";
+import { setDb } from "./index";
+import { validateConfig, validateMongoUri } from "../utils/validation";
+
+class MunicipalDataMongoDBClient {
+  private client: MongoClient | null = null;
+  private db: Db | null = null;
+  private readonly defaultDbName = "municipal-data";
+
+  async connect(uri?: string, dbName?: string): Promise<void> {
+    if (this.client) {
+      return;
+    }
+
+    const mongodbUri = uri || process.env.MONGO_URI || process.env.MONGODB_URI;
+    validateConfig("MONGO_URI", mongodbUri);
+    validateMongoUri(mongodbUri!);
+
+    try {
+      this.client = new MongoClient(mongodbUri!);
+      await this.client.connect();
+      const targetDbName =
+        dbName || process.env.MUNICIPAL_DB_NAME || this.defaultDbName;
+      this.db = this.client.db(targetDbName);
+      setDb(this.db);
+      console.info(`[core-db] Municipal MongoDB connected: ${targetDbName}`);
+    } catch (error) {
+      console.error("[core-db] Municipal connection failed", error);
+      throw error;
+    }
+  }
+
+  async disconnect(): Promise<void> {
+    if (this.client) {
+      try {
+        await this.client.close();
+        this.client = null;
+        this.db = null;
+        console.info("Municipal Data MongoDB disconnected successfully");
+      } catch (error) {
+        console.error("[core-db] Municipal disconnection failed", error);
+        throw error;
+      }
+    }
+  }
+
+  getDb(): Db {
+    if (!this.db) {
+      throw new Error(
+        "Municipal Data database not initialized. Call connect() first.",
+      );
+    }
+    return this.db;
+  }
+
+  isConnected(): boolean {
+    return this.client !== null && this.client !== undefined;
+  }
+}
+
+export const municipalDataMongodbClient = new MunicipalDataMongoDBClient();

package/src/municipal/muniIssues/__tests__/muniIssues.setters.spec.ts

@@ -1,199 +1,94 @@
-import {
-  createMuniIssue,
-  setMuniIssueResponse,
-  updateMuniIssueStatus,
-} from "../muniIssues.setters";
-import {
-  generateMuniIssueId,
-  getMuniIssueById,
-  getMuniIssueByJiraKey,
-} from "../muniIssues.getters";
-import { createMuniIssueInput } from "../../../test-utils/factories";
-
-describe("muniIssues setters", () => {
-  describe("createMuniIssue", () => {
-    it("should insert a well-formed document with createdAt and nested content/jira", async () => {
-      const input = createMuniIssueInput();
-      const id = generateMuniIssueId();
-
-      const insertedId = await createMuniIssue(input, id);
-
-      const saved = await getMuniIssueById(insertedId.toString());
-      expect(saved).toMatchObject({
-        callSid: input.callSid,
-        clientId: input.clientId,
-        cityName: input.cityName,
-        issueContent: input.issueContent,
-        jira: input.jira,
-      });
-      expect(saved?.createdAt).toBeInstanceOf(Date);
-    });
-
-    it("should start the issue as in_review with updatedAt and no response", async () => {
-      const insertedId = await createMuniIssue(
-        createMuniIssueInput(),
-        generateMuniIssueId(),
-      );
-
-      const saved = await getMuniIssueById(insertedId.toString());
-      expect(saved?.status).toBe("in_review");
-      expect(saved?.updatedAt).toBeInstanceOf(Date);
-      expect(saved?.response).toBeUndefined();
-    });
-
-    it("should default jira.syncStatus to created when not provided", async () => {
-      const id = generateMuniIssueId();
-
-      const insertedId = await createMuniIssue(
-        createMuniIssueInput({ jira: { key: "CP-9" } }),
-        id,
-      );
-
-      const saved = await getMuniIssueById(insertedId.toString());
-      expect(saved?.jira.syncStatus).toBe("created");
-    });
-
-    it("should store long issueDescription and desiredBehavior in full", async () => {
-      const issueDescription = "a".repeat(2000);
-      const desiredBehavior = "b".repeat(2000);
-      const id = generateMuniIssueId();
-
-      const insertedId = await createMuniIssue(
-        createMuniIssueInput({
-          issueContent: {
-            issuerName: "Dana",
-            issuerRole: "Agent",
-            issueDescription,
-            desiredBehavior,
-          },
-        }),
-        id,
-      );
-
-      const saved = await getMuniIssueById(insertedId.toString());
-      expect(saved?.issueContent.issueDescription).toHaveLength(2000);
-      expect(saved?.issueContent.desiredBehavior).toBe(desiredBehavior);
-    });
-
-    it("should persist the caller-supplied _id so the Jira ticket can link back", async () => {
-      const id = generateMuniIssueId();
-
-      const insertedId = await createMuniIssue(createMuniIssueInput(), id);
-
-      expect(insertedId.toString()).toBe(id.toString());
-      expect(await getMuniIssueById(id.toString())).not.toBeNull();
-    });
-  });
-
-  describe("getMuniIssueById", () => {
-    it("should return null for an unknown or malformed id instead of throwing", async () => {
-      expect(
-        await getMuniIssueById(generateMuniIssueId().toString()),
-      ).toBeNull();
-      expect(await getMuniIssueById("not-a-valid-id")).toBeNull();
-    });
-  });
-
-  describe("getMuniIssueByJiraKey", () => {
-    it("should find the issue with the given Jira key", async () => {
-      await createMuniIssue(
-        createMuniIssueInput({ jira: { key: "CP-555" } }),
-        generateMuniIssueId(),
-      );
-
-      const found = await getMuniIssueByJiraKey("CP-555");
-
-      expect(found?.jira.key).toBe("CP-555");
-      expect(await getMuniIssueByJiraKey("CP-nope")).toBeNull();
-    });
-  });
-
-  describe("updateMuniIssueStatus", () => {
-    it("should change the status of an unanswered issue", async () => {
-      const input = createMuniIssueInput();
-      const id = (await createMuniIssue(input, generateMuniIssueId())).toString();
-
-      expect(await updateMuniIssueStatus(id, input.clientId, "in_progress")).toBe(true);
-      expect((await getMuniIssueById(id))?.status).toBe("in_progress");
-    });
-
-    it("should not touch another client's issue or a malformed id", async () => {
-      const id = (
-        await createMuniIssue(createMuniIssueInput(), generateMuniIssueId())
-      ).toString();
-
-      expect(await updateMuniIssueStatus(id, "other-client", "resolved")).toBe(false);
-      expect(await updateMuniIssueStatus("not-a-valid-id", "any", "resolved")).toBe(false);
-      expect((await getMuniIssueById(id))?.status).toBe("in_review");
-    });
-  });
-
-  describe("setMuniIssueResponse", () => {
-    it("should save the response and status", async () => {
-      const input = createMuniIssueInput();
-      const id = (await createMuniIssue(input, generateMuniIssueId())).toString();
-
-      const saved = await setMuniIssueResponse(id, input.clientId, {
-        status: "resolved",
-        text: "Fixed",
-        imageUrls: ["https://example.com/a.png", "https://example.com/b.png"],
-      });
-
-      expect(saved).toBe(true);
-      const issue = await getMuniIssueById(id);
-      expect(issue?.status).toBe("resolved");
-      expect(issue?.response).toMatchObject({
-        text: "Fixed",
-        imageUrls: ["https://example.com/a.png", "https://example.com/b.png"],
-      });
-      expect(issue?.response?.createdAt).toBeInstanceOf(Date);
-      expect(issue?.response?.updatedAt).toBeUndefined();
-    });
-
-    it("should let an answered issue be edited, keeping the first-sent date", async () => {
-      const input = createMuniIssueInput();
-      const id = (await createMuniIssue(input, generateMuniIssueId())).toString();
-      await setMuniIssueResponse(id, input.clientId, {
-        status: "in_review",
-        text: "First",
-        imageUrls: ["https://example.com/a.png"],
-      });
-      const firstSentAt = (await getMuniIssueById(id))?.response?.createdAt;
-
-      expect(
-        await setMuniIssueResponse(id, input.clientId, { status: "resolved", text: "Second" }),
-      ).toBe(true);
-      expect(await updateMuniIssueStatus(id, input.clientId, "no_issue_found")).toBe(true);
-
-      const issue = await getMuniIssueById(id);
-      expect(issue?.status).toBe("no_issue_found");
-      expect(issue?.response?.text).toBe("Second");
-      expect(issue?.response?.imageUrls).toEqual([]);
-      expect(issue?.response?.createdAt).toEqual(firstSentAt);
-      expect(issue?.response?.updatedAt).toBeInstanceOf(Date);
-    });
-
-    it("should store text starting with $ as plain text", async () => {
-      const input = createMuniIssueInput();
-      const id = (await createMuniIssue(input, generateMuniIssueId())).toString();
-
-      await setMuniIssueResponse(id, input.clientId, { status: "resolved", text: "$status" });
-
-      expect((await getMuniIssueById(id))?.response?.text).toBe("$status");
-    });
-
-    it("should not touch another client's issue or a malformed id", async () => {
-      const id = (
-        await createMuniIssue(createMuniIssueInput(), generateMuniIssueId())
-      ).toString();
-
-      expect(
-        await setMuniIssueResponse(id, "other-client", { status: "resolved", text: "X" }),
-      ).toBe(false);
-      expect(
-        await setMuniIssueResponse("not-a-valid-id", "any", { status: "resolved", text: "X" }),
-      ).toBe(false);
-      expect((await getMuniIssueById(id))?.response).toBeUndefined();
-    });
-  });
-});
+import { createMuniIssue } from "../muniIssues.setters";
+import {
+  generateMuniIssueId,
+  getMuniIssueById,
+  getMuniIssueByJiraKey,
+} from "../muniIssues.getters";
+import { createMuniIssueInput } from "../../../test-utils/factories";
+
+describe("muniIssues setters", () => {
+  describe("createMuniIssue", () => {
+    it("should insert a well-formed document with createdAt and nested content/jira", async () => {
+      const input = createMuniIssueInput();
+      const id = generateMuniIssueId();
+
+      const insertedId = await createMuniIssue(input, id);
+
+      const saved = await getMuniIssueById(insertedId.toString());
+      expect(saved).toMatchObject({
+        callSid: input.callSid,
+        clientId: input.clientId,
+        cityName: input.cityName,
+        issueContent: input.issueContent,
+        jira: input.jira,
+      });
+      expect(saved?.createdAt).toBeInstanceOf(Date);
+    });
+
+    it("should default jira.syncStatus to created when not provided", async () => {
+      const id = generateMuniIssueId();
+
+      const insertedId = await createMuniIssue(
+        createMuniIssueInput({ jira: { key: "CP-9" } }),
+        id,
+      );
+
+      const saved = await getMuniIssueById(insertedId.toString());
+      expect(saved?.jira.syncStatus).toBe("created");
+    });
+
+    it("should store long issueDescription and desiredBehavior in full", async () => {
+      const issueDescription = "a".repeat(2000);
+      const desiredBehavior = "b".repeat(2000);
+      const id = generateMuniIssueId();
+
+      const insertedId = await createMuniIssue(
+        createMuniIssueInput({
+          issueContent: {
+            issuerName: "Dana",
+            issuerRole: "Agent",
+            issueDescription,
+            desiredBehavior,
+          },
+        }),
+        id,
+      );
+
+      const saved = await getMuniIssueById(insertedId.toString());
+      expect(saved?.issueContent.issueDescription).toHaveLength(2000);
+      expect(saved?.issueContent.desiredBehavior).toBe(desiredBehavior);
+    });
+
+    it("should persist the caller-supplied _id so the Jira ticket can link back", async () => {
+      const id = generateMuniIssueId();
+
+      const insertedId = await createMuniIssue(createMuniIssueInput(), id);
+
+      expect(insertedId.toString()).toBe(id.toString());
+      expect(await getMuniIssueById(id.toString())).not.toBeNull();
+    });
+  });
+
+  describe("getMuniIssueById", () => {
+    it("should return null for an unknown or malformed id instead of throwing", async () => {
+      expect(
+        await getMuniIssueById(generateMuniIssueId().toString()),
+      ).toBeNull();
+      expect(await getMuniIssueById("not-a-valid-id")).toBeNull();
+    });
+  });
+
+  describe("getMuniIssueByJiraKey", () => {
+    it("should find the issue with the given Jira key", async () => {
+      await createMuniIssue(
+        createMuniIssueInput({ jira: { key: "CP-555" } }),
+        generateMuniIssueId(),
+      );
+
+      const found = await getMuniIssueByJiraKey("CP-555");
+
+      expect(found?.jira.key).toBe("CP-555");
+      expect(await getMuniIssueByJiraKey("CP-nope")).toBeNull();
+    });
+  });
+});