@talkpilot/core-db 1.2.0 → 1.2.1

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

@@ -1,72 +1,72 @@
-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;
-};
-
-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;
+};
+
+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,21 +1,21 @@
-import { Db, ObjectId as MongoObjectId } from "mongodb";
-
-export * from "./cities";
-export * from "./streets";
-export * from "./departmentsSubjects";
-export * from "./tickets";
-export * from "./systemInstructions";
-export * from "./utils/types";
-export { 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 "./utils/types";
+export { 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/streets/index.ts

@@ -1,2 +1,2 @@
-export * from "./streets.getters";
-export type { Street, StreetDoc, StreetHint } from "./streets.types";
+export * from "./streets.getters";
+export type { Street, StreetDoc, StreetHint } from "./streets.types";

package/src/municipal/streets/streets.getters.ts

@@ -1,125 +1,125 @@
-import { CityName, getDb, ObjectId, Street } from "../index";
-import type { StreetHint } from "./streets.types";
-import { Collection, Filter, ObjectId as MongoObjectId } from "mongodb";
-
-export const getStreetsCollection = (): Collection<Street> => {
-  return getDb().collection<Street>("streets");
-};
-
-export const findStreets = async (
-  filter: Filter<Street> = {},
-): Promise<Street[]> => {
-  return await getStreetsCollection().find(filter).toArray();
-};
-
-export const getStreetById = async (
-  streetId: string,
-): Promise<Street | null> => {
-  const street = await getStreetsCollection().findOne({
-    _id: new ObjectId(streetId),
-  });
-  return street ? street : null;
-};
-
-export const getStreetsByCityName = async (
-  cityName: CityName,
-): Promise<Street[]> => {
-  return await getStreetsCollection()
-    .find({ cityName })
-    .sort({ name: 1 })
-    .toArray();
-};
-
-export const getStreetByStreetId = async (
-  streetId: string,
-): Promise<Street | null> => {
-  const street = await getStreetsCollection().findOne({ id: streetId });
-  return street ? street : null;
-};
-
-/** Get street by business id and city. Use this when the client's city is known so the same id in another city is not returned. */
-export const getStreetByStreetIdAndCity = async (
-  streetId: string,
-  cityName: CityName,
-): Promise<Street | null> => {
-  const street = await getStreetsCollection().findOne({
-    id: streetId,
-    cityName,
-  });
-  return street ? street : null;
-};
-
-export const createStreet = async (
-  streetData: Omit<Street, "_id" | "createdAt" | "updatedAt">,
-): Promise<MongoObjectId> => {
-  const street: Omit<Street, "_id"> = {
-    ...streetData,
-    createdAt: new Date(),
-    updatedAt: new Date(),
-  };
-  const { insertedId } = await getStreetsCollection().insertOne(
-    street as Street,
-  );
-  return insertedId;
-};
-
-export const updateStreet = async (
-  streetId: string,
-  data: Partial<Omit<Street, "_id" | "createdAt" | "updatedAt">>,
-): Promise<Street | null> => {
-  const result = await getStreetsCollection().findOneAndUpdate(
-    { _id: new ObjectId(streetId) },
-    { $set: { ...data, updatedAt: new Date() } },
-    { returnDocument: "after" },
-  );
-  return result || null;
-};
-
-/**
- * Add or update a street hint on an already-fetched street.
- * Only place that creates a new hint id (Date.getTime().toString()). Returns null if hint.id provided but not found, or text empty.
- */
-export const upsertStreetHintOnStreet = async (
-  street: Street,
-  hint: Partial<StreetHint> & Pick<StreetHint, "text">,
-): Promise<Street | null> => {
-  const text = hint.text.trim();
-  if (!text) return null;
-
-  const hints = street.hints || [];
-  let updatedHints: StreetHint[];
-
-  if (hint.id != null && hint.id !== "") {
-    const hintIndex = hints.findIndex((h) => String(h.id) === String(hint.id));
-    if (hintIndex === -1) return null;
-    updatedHints = [...hints];
-    updatedHints[hintIndex] = { id: String(hint.id), text };
-  } else {
-    updatedHints = [...hints, { id: new Date().getTime().toString(), text }];
-  }
-
-  return updateStreet(street._id.toString(), { hints: updatedHints });
-};
-
-/** Remove a hint from a street. streetId is the street business id (e.g. "703"). Updates document updatedAt. */
-export const deleteStreetHint = async (
-  streetId: string,
-  hintId: string,
-): Promise<Street | null> => {
-  const result = await getStreetsCollection().findOneAndUpdate(
-    { id: streetId },
-    { $pull: { hints: { id: hintId } }, $set: { updatedAt: new Date() } },
-    { returnDocument: "after" },
-  );
-  if (result) {
-    console.info("Street hint deleted", { streetId, hintId });
-  }
-  return result || null;
-};
-
-export const deleteStreet = async (streetId: string): Promise<boolean> => {
-  const result = await getStreetsCollection().deleteOne({
-    _id: new ObjectId(streetId),
-  });
-  return result.deletedCount > 0;
-};
+import { CityName, getDb, ObjectId, Street } from "../index";
+import type { StreetHint } from "./streets.types";
+import { Collection, Filter, ObjectId as MongoObjectId } from "mongodb";
+
+export const getStreetsCollection = (): Collection<Street> => {
+  return getDb().collection<Street>("streets");
+};
+
+export const findStreets = async (
+  filter: Filter<Street> = {},
+): Promise<Street[]> => {
+  return await getStreetsCollection().find(filter).toArray();
+};
+
+export const getStreetById = async (
+  streetId: string,
+): Promise<Street | null> => {
+  const street = await getStreetsCollection().findOne({
+    _id: new ObjectId(streetId),
+  });
+  return street ? street : null;
+};
+
+export const getStreetsByCityName = async (
+  cityName: CityName,
+): Promise<Street[]> => {
+  return await getStreetsCollection()
+    .find({ cityName })
+    .sort({ name: 1 })
+    .toArray();
+};
+
+export const getStreetByStreetId = async (
+  streetId: string,
+): Promise<Street | null> => {
+  const street = await getStreetsCollection().findOne({ id: streetId });
+  return street ? street : null;
+};
+
+/** Get street by business id and city. Use this when the client's city is known so the same id in another city is not returned. */
+export const getStreetByStreetIdAndCity = async (
+  streetId: string,
+  cityName: CityName,
+): Promise<Street | null> => {
+  const street = await getStreetsCollection().findOne({
+    id: streetId,
+    cityName,
+  });
+  return street ? street : null;
+};
+
+export const createStreet = async (
+  streetData: Omit<Street, "_id" | "createdAt" | "updatedAt">,
+): Promise<MongoObjectId> => {
+  const street: Omit<Street, "_id"> = {
+    ...streetData,
+    createdAt: new Date(),
+    updatedAt: new Date(),
+  };
+  const { insertedId } = await getStreetsCollection().insertOne(
+    street as Street,
+  );
+  return insertedId;
+};
+
+export const updateStreet = async (
+  streetId: string,
+  data: Partial<Omit<Street, "_id" | "createdAt" | "updatedAt">>,
+): Promise<Street | null> => {
+  const result = await getStreetsCollection().findOneAndUpdate(
+    { _id: new ObjectId(streetId) },
+    { $set: { ...data, updatedAt: new Date() } },
+    { returnDocument: "after" },
+  );
+  return result || null;
+};
+
+/**
+ * Add or update a street hint on an already-fetched street.
+ * Only place that creates a new hint id (Date.getTime().toString()). Returns null if hint.id provided but not found, or text empty.
+ */
+export const upsertStreetHintOnStreet = async (
+  street: Street,
+  hint: Partial<StreetHint> & Pick<StreetHint, "text">,
+): Promise<Street | null> => {
+  const text = hint.text.trim();
+  if (!text) return null;
+
+  const hints = street.hints || [];
+  let updatedHints: StreetHint[];
+
+  if (hint.id != null && hint.id !== "") {
+    const hintIndex = hints.findIndex((h) => String(h.id) === String(hint.id));
+    if (hintIndex === -1) return null;
+    updatedHints = [...hints];
+    updatedHints[hintIndex] = { id: String(hint.id), text };
+  } else {
+    updatedHints = [...hints, { id: new Date().getTime().toString(), text }];
+  }
+
+  return updateStreet(street._id.toString(), { hints: updatedHints });
+};
+
+/** Remove a hint from a street. streetId is the street business id (e.g. "703"). Updates document updatedAt. */
+export const deleteStreetHint = async (
+  streetId: string,
+  hintId: string,
+): Promise<Street | null> => {
+  const result = await getStreetsCollection().findOneAndUpdate(
+    { id: streetId },
+    { $pull: { hints: { id: hintId } }, $set: { updatedAt: new Date() } },
+    { returnDocument: "after" },
+  );
+  if (result) {
+    console.info("Street hint deleted", { streetId, hintId });
+  }
+  return result || null;
+};
+
+export const deleteStreet = async (streetId: string): Promise<boolean> => {
+  const result = await getStreetsCollection().deleteOne({
+    _id: new ObjectId(streetId),
+  });
+  return result.deletedCount > 0;
+};

package/src/municipal/streets/streets.types.ts

@@ -1,18 +1,18 @@
-import { ObjectId, WithId } from "mongodb";
-
-export type StreetHint = {
-  id: string;
-  text: string;
-};
-
-export type Street = {
-  _id: ObjectId;
-  createdAt: Date;
-  updatedAt: Date;
-  id: string;
-  name: string;
-  cityName: string;
-  hints?: StreetHint[];
-};
-
-export type StreetDoc = WithId<Street>;
+import { ObjectId, WithId } from "mongodb";
+
+export type StreetHint = {
+  id: string;
+  text: string;
+};
+
+export type Street = {
+  _id: ObjectId;
+  createdAt: Date;
+  updatedAt: Date;
+  id: string;
+  name: string;
+  cityName: string;
+  hints?: StreetHint[];
+};
+
+export type StreetDoc = WithId<Street>;