@talkpilot/core-db 1.3.7 → 1.3.9

package/dist/utils/statistics.aggregation.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.warnIfLargeSidArray = exports.callSidInSetExpr = exports.buildCallSidLookup = exports.resolveMaxTimeMS = exports.StatisticsTimeoutError = exports.MAX_RECOMMENDED_SID_ARRAY_SIZE = exports.DEFAULT_STATS_MAX_TIME_MS = void 0;
+/** Default server-side cap for statistics aggregations (30s). */
+exports.DEFAULT_STATS_MAX_TIME_MS = 30_000;
+/** Log a warning when SID arrays exceed this size (BSON / pipeline pressure). */
+exports.MAX_RECOMMENDED_SID_ARRAY_SIZE = 10_000;
+class StatisticsTimeoutError extends Error {
+    constructor(maxTimeMS) {
+        super(`Statistics aggregation exceeded maxTimeMS (${maxTimeMS})`);
+        this.name = "StatisticsTimeoutError";
+    }
+}
+exports.StatisticsTimeoutError = StatisticsTimeoutError;
+const resolveMaxTimeMS = (options) => options?.maxTimeMS ?? exports.DEFAULT_STATS_MAX_TIME_MS;
+exports.resolveMaxTimeMS = resolveMaxTimeMS;
+/** Builds a constant lookup object for O(1) membership checks via $getField. */
+const buildCallSidLookup = (callSids) => Object.fromEntries(callSids.map((sid) => [sid, true]));
+exports.buildCallSidLookup = buildCallSidLookup;
+/**
+ * $expr that is true when `$callSid` is in `callSids`.
+ * Prefer over `$in` for large arrays embedded in aggregation pipelines.
+ */
+const callSidInSetExpr = (callSids) => ({
+    $eq: [
+        {
+            $getField: {
+                field: "$callSid",
+                input: (0, exports.buildCallSidLookup)(callSids),
+                default: false,
+            },
+        },
+        true,
+    ],
+});
+exports.callSidInSetExpr = callSidInSetExpr;
+const warnIfLargeSidArray = (label, callSids) => {
+    if (callSids.length > exports.MAX_RECOMMENDED_SID_ARRAY_SIZE) {
+        console.warn(`[core-db statistics] ${label}: ${callSids.length} call SIDs exceeds recommended max (${exports.MAX_RECOMMENDED_SID_ARRAY_SIZE}). Narrow the date range or cache SIDs once per request.`);
+    }
+};
+exports.warnIfLargeSidArray = warnIfLargeSidArray;
+//# sourceMappingURL=statistics.aggregation.js.map

package/dist/utils/statistics.aggregation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"statistics.aggregation.js","sourceRoot":"","sources":["../../src/utils/statistics.aggregation.ts"],"names":[],"mappings":";;;AAAA,iEAAiE;AACpD,QAAA,yBAAyB,GAAG,MAAM,CAAC;AAEhD,iFAAiF;AACpE,QAAA,8BAA8B,GAAG,MAAM,CAAC;AAMrD,MAAa,sBAAuB,SAAQ,KAAK;IAC/C,YAAY,SAAiB;QAC3B,KAAK,CAAC,8CAA8C,SAAS,GAAG,CAAC,CAAC;QAClE,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;IACvC,CAAC;CACF;AALD,wDAKC;AAEM,MAAM,gBAAgB,GAAG,CAAC,OAAsC,EAAU,EAAE,CACjF,OAAO,EAAE,SAAS,IAAI,iCAAyB,CAAC;AADrC,QAAA,gBAAgB,oBACqB;AAElD,gFAAgF;AACzE,MAAM,kBAAkB,GAAG,CAAC,QAAkB,EAAwB,EAAE,CAC7E,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAyB,CAAC;AADpE,QAAA,kBAAkB,sBACkD;AAEjF;;;GAGG;AACI,MAAM,gBAAgB,GAAG,CAAC,QAAkB,EAA2B,EAAE,CAAC,CAAC;IAChF,GAAG,EAAE;QACH;YACE,SAAS,EAAE;gBACT,KAAK,EAAE,UAAU;gBACjB,KAAK,EAAE,IAAA,0BAAkB,EAAC,QAAQ,CAAC;gBACnC,OAAO,EAAE,KAAK;aACf;SACF;QACD,IAAI;KACL;CACF,CAAC,CAAC;AAXU,QAAA,gBAAgB,oBAW1B;AAEI,MAAM,mBAAmB,GAAG,CAAC,KAAa,EAAE,QAAkB,EAAQ,EAAE;IAC7E,IAAI,QAAQ,CAAC,MAAM,GAAG,sCAA8B,EAAE,CAAC;QACrD,OAAO,CAAC,IAAI,CACV,wBAAwB,KAAK,KAAK,QAAQ,CAAC,MAAM,uCAAuC,sCAA8B,0DAA0D,CACjL,CAAC;IACJ,CAAC;AACH,CAAC,CAAC;AANW,QAAA,mBAAmB,uBAM9B"}

package/jest.config.js

@@ -1,20 +1,20 @@
-/** @type {import('ts-jest').JestConfigWithTsJest} */
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  roots: ['<rootDir>/src'],
-  testPathIgnorePatterns: ['<rootDir>/src/__tests__/legacy/'],
-  testMatch: ['**/__tests__/**/*.spec.ts', '**/*.spec.ts'],
-  transform: {
-    '^.+\\.tsx?$': ['ts-jest', {
-      tsconfig: 'tsconfig.json',
-    }],
-  },
-  setupFilesAfterEnv: ['<rootDir>/src/__tests__/setup.ts'],
-  maxWorkers: 1,
-  verbose: true,
-  forceExit: true,
-  clearMocks: true,
-  resetMocks: true,
-  restoreMocks: true,
-};
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  roots: ['<rootDir>/src'],
+  testPathIgnorePatterns: ['<rootDir>/src/__tests__/legacy/'],
+  testMatch: ['**/__tests__/**/*.spec.ts', '**/*.spec.ts'],
+  transform: {
+    '^.+\\.tsx?$': ['ts-jest', {
+      tsconfig: 'tsconfig.json',
+    }],
+  },
+  setupFilesAfterEnv: ['<rootDir>/src/__tests__/setup.ts'],
+  maxWorkers: 1,
+  verbose: true,
+  forceExit: true,
+  clearMocks: true,
+  resetMocks: true,
+  restoreMocks: true,
+};

package/package.json

@@ -1,46 +1,46 @@
-{
-  "name": "@talkpilot/core-db",
-  "version": "1.3.7",
-  "description": "Core database package for centralized connections and ORM integration.",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "tsc",
-    "dev": "tsc --watch",
-    "test": "jest",
-    "lint": "eslint 'src/**/*.{ts,tsx}'",
-    "format": "prettier --write \"src/**/*.{ts,tsx}\"",
-    "prepare": "npm run build"
-  },
-  "keywords": [
-    "database",
-    "orm",
-    "typescript",
-    "postgres",
-    "db-client"
-  ],
-  "author": "",
-  "license": "MIT",
-  "dependencies": {
-    "dayjs": "^1.11.21",
-    "express": "^4.18.0",
-    "google-libphonenumber": "^3.2.0",
-    "mongodb": "^6.11.0"
-  },
-  "devDependencies": {
-    "@faker-js/faker": "^8.0.0",
-    "@types/express": "^4.17.0",
-    "@types/google-libphonenumber": "^7.4.0",
-    "@types/jest": "^29.0.0",
-    "@types/node": "^20.0.0",
-    "fishery": "^2.4.0",
-    "jest": "^29.0.0",
-    "mongodb-memory-server": "^10.0.0",
-    "prettier": "^3.8.2",
-    "ts-jest": "^29.0.0",
-    "typescript": "^5.0.0"
-  },
-  "publishConfig": {
-    "access": "public"
-  }
-}
+{
+  "name": "@talkpilot/core-db",
+  "version": "1.3.9",
+  "description": "Core database package for centralized connections and ORM integration.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "test": "jest",
+    "lint": "eslint 'src/**/*.{ts,tsx}'",
+    "format": "prettier --write \"src/**/*.{ts,tsx}\"",
+    "prepare": "npm run build"
+  },
+  "keywords": [
+    "database",
+    "orm",
+    "typescript",
+    "postgres",
+    "db-client"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "dayjs": "^1.11.21",
+    "express": "^4.18.0",
+    "google-libphonenumber": "^3.2.0",
+    "mongodb": "^6.11.0"
+  },
+  "devDependencies": {
+    "@faker-js/faker": "^8.0.0",
+    "@types/express": "^4.17.0",
+    "@types/google-libphonenumber": "^7.4.0",
+    "@types/jest": "^29.0.0",
+    "@types/node": "^20.0.0",
+    "fishery": "^2.4.0",
+    "jest": "^29.0.0",
+    "mongodb-memory-server": "^10.0.0",
+    "prettier": "^3.8.2",
+    "ts-jest": "^29.0.0",
+    "typescript": "^5.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/__tests__/setup.ts

@@ -1,20 +1,20 @@
-import { initTestDb, closeTestDb } from "../test-utils/db-utils";
-
-declare global {
-  // eslint-disable-next-line no-var
-  var db: import("mongodb").Db;
-}
-
-// Set up global mocks if needed
-// global.fetch = jest.fn();
-
-beforeEach(async () => {
-  global.db = await initTestDb();
-}, 30_000);
-
-afterEach(async () => {
-  await closeTestDb();
-  jest.resetAllMocks();
-});
-
-process.env.NODE_ENV = "test";
+import { initTestDb, closeTestDb } from "../test-utils/db-utils";
+
+declare global {
+  // eslint-disable-next-line no-var
+  var db: import("mongodb").Db;
+}
+
+// Set up global mocks if needed
+// global.fetch = jest.fn();
+
+beforeEach(async () => {
+  global.db = await initTestDb();
+}, 30_000);
+
+afterEach(async () => {
+  await closeTestDb();
+  jest.resetAllMocks();
+});
+
+process.env.NODE_ENV = "test";

package/src/connection.ts

@@ -1,54 +1,54 @@
-import { mongodbClient } from "./talkpilot";
-import { municipalDataMongodbClient } from "./municipal";
-import { websitalkMongodbClient } from "./websitalk";
-
-let isConnected = false;
-
-/**
- * Ensures the database clients are initialized.
- * This function reads from MONGO_URI.
- */
-export async function ensureDbConnected() {
-  if (isConnected) {
-    return;
-  }
-
-  const mongoUri = process.env.MONGO_URI || process.env.MONGODB_URI;
-  const talkpilotUri = mongoUri;
-  const municipalUri = mongoUri;
-  const websiteTalkUri = mongoUri;
-
-  if (!talkpilotUri) {
-    console.warn("[core-db] MONGO_URI is not set");
-  } else {
-    const dbNameFromUri = talkpilotUri.split("/").pop()?.split("?")[0];
-    const dbName = dbNameFromUri || process.env.TALKPILOT_DB_NAME;
-    await mongodbClient.connect(talkpilotUri, dbName);
-    console.info(
-      `[core-db] Connected to TalkPilot MongoDB: ${dbName || "via env"}`,
-    );
-  }
-
-  if (!municipalUri) {
-    console.warn("[core-db] MONGO_URI is not set");
-  } else {
-    const dbNameFromUri = municipalUri.split("/").pop()?.split("?")[0];
-    const dbName = dbNameFromUri || process.env.MUNICIPAL_DB_NAME;
-    await municipalDataMongodbClient.connect(municipalUri, dbName);
-    console.info(
-      `[core-db] Connected to Municipal Data MongoDB: ${dbName || "via env"}`,
-    );
-  }
-
-  if (!websiteTalkUri) {
-    console.warn("[core-db] MONGO_URI is not set");
-  } else {
-    const dbName = process.env.WEBSITALK_DB_NAME;
-    await websitalkMongodbClient.connect(websiteTalkUri, dbName);
-    console.info(
-      `[core-db] Connected to Website Talk MongoDB: ${dbName || "website-talk (default)"}`,
-    );
-  }
-
-  isConnected = true;
-}
+import { mongodbClient } from "./talkpilot";
+import { municipalDataMongodbClient } from "./municipal";
+import { websitalkMongodbClient } from "./websitalk";
+
+let isConnected = false;
+
+/**
+ * Ensures the database clients are initialized.
+ * This function reads from MONGO_URI.
+ */
+export async function ensureDbConnected() {
+  if (isConnected) {
+    return;
+  }
+
+  const mongoUri = process.env.MONGO_URI || process.env.MONGODB_URI;
+  const talkpilotUri = mongoUri;
+  const municipalUri = mongoUri;
+  const websiteTalkUri = mongoUri;
+
+  if (!talkpilotUri) {
+    console.warn("[core-db] MONGO_URI is not set");
+  } else {
+    const dbNameFromUri = talkpilotUri.split("/").pop()?.split("?")[0];
+    const dbName = dbNameFromUri || process.env.TALKPILOT_DB_NAME;
+    await mongodbClient.connect(talkpilotUri, dbName);
+    console.info(
+      `[core-db] Connected to TalkPilot MongoDB: ${dbName || "via env"}`,
+    );
+  }
+
+  if (!municipalUri) {
+    console.warn("[core-db] MONGO_URI is not set");
+  } else {
+    const dbNameFromUri = municipalUri.split("/").pop()?.split("?")[0];
+    const dbName = dbNameFromUri || process.env.MUNICIPAL_DB_NAME;
+    await municipalDataMongodbClient.connect(municipalUri, dbName);
+    console.info(
+      `[core-db] Connected to Municipal Data MongoDB: ${dbName || "via env"}`,
+    );
+  }
+
+  if (!websiteTalkUri) {
+    console.warn("[core-db] MONGO_URI is not set");
+  } else {
+    const dbName = process.env.WEBSITALK_DB_NAME;
+    await websitalkMongodbClient.connect(websiteTalkUri, dbName);
+    console.info(
+      `[core-db] Connected to Website Talk MongoDB: ${dbName || "website-talk (default)"}`,
+    );
+  }
+
+  isConnected = true;
+}

package/src/index.ts

@@ -1,26 +1,26 @@
-// TalkPilot DB exports
-export * from "./talkpilot";
-export * from "./connection";
-
-export {
-  municipalDataMongodbClient,
-  getDb as getMunicipalDataDb,
-  setDb as setMunicipalDataDb,
-  ObjectId as MunicipalDataObjectId,
-} from "./municipal";
-export * from "./municipal/cities";
-export * from "./municipal/streets";
-export * from "./municipal/departmentsSubjects";
-export * from "./municipal/tickets";
-export * from "./municipal/systemInstructions";
-export * from "./municipal/muniIssues";
-export * from "./municipal/utils/types";
-
-export {
-  websitalkMongodbClient,
-  getDb as getWebsitalkDb,
-  setDb as setWebsitalkDb,
-  ObjectId as WebsitalkObjectId,
-} from "./websitalk";
-export * from "./websitalk/scans/scans.getters";
-export type * from "./websitalk/scans/scans.types";
+// TalkPilot DB exports
+export * from "./talkpilot";
+export * from "./connection";
+
+export {
+  municipalDataMongodbClient,
+  getDb as getMunicipalDataDb,
+  setDb as setMunicipalDataDb,
+  ObjectId as MunicipalDataObjectId,
+} from "./municipal";
+export * from "./municipal/cities";
+export * from "./municipal/streets";
+export * from "./municipal/departmentsSubjects";
+export * from "./municipal/tickets";
+export * from "./municipal/systemInstructions";
+export * from "./municipal/muniIssues";
+export * from "./municipal/utils/types";
+
+export {
+  websitalkMongodbClient,
+  getDb as getWebsitalkDb,
+  setDb as setWebsitalkDb,
+  ObjectId as WebsitalkObjectId,
+} from "./websitalk";
+export * from "./websitalk/scans/scans.getters";
+export type * from "./websitalk/scans/scans.types";

package/src/municipal/__tests__/validation.spec.ts

@@ -1,62 +1,62 @@
-import { municipalDataMongodbClient } from "../mongodb-client";
-import { MongoClient } from "mongodb";
-
-describe("MunicipalDataMongoDBClient Validation", () => {
-  const originalEnv = process.env;
-
-  beforeEach(() => {
-    process.env = { ...originalEnv };
-    delete process.env.MONGO_URI;
-    delete process.env.MONGODB_URI;
-
-    // Force reset singleton state
-    (municipalDataMongodbClient as any).client = null;
-    (municipalDataMongodbClient as any).db = null;
-  });
-
-  afterAll(async () => {
-    process.env = originalEnv;
-    await municipalDataMongodbClient.disconnect();
-  });
-
-  it("should succeed with default database name if only URI is provided", async () => {
-    const mockDb = { databaseName: "municipal-data" };
-    const connectSpy = jest
-      .spyOn(MongoClient.prototype, "connect")
-      .mockResolvedValue({} as any);
-    const dbSpy = jest
-      .spyOn(MongoClient.prototype, "db")
-      .mockReturnValue(mockDb as any);
-
-    const validUri = "mongodb://127.0.0.1:27017";
-    await municipalDataMongodbClient.connect(validUri);
-
-    expect(municipalDataMongodbClient.getDb()).toBeDefined();
-    expect(municipalDataMongodbClient.getDb().databaseName).toBe(
-      "municipal-data",
-    );
-
-    connectSpy.mockRestore();
-    dbSpy.mockRestore();
-  });
-
-  it("should allow overriding the default database name", async () => {
-    const mockDb = { databaseName: "custom-municipal-db" };
-    const connectSpy = jest
-      .spyOn(MongoClient.prototype, "connect")
-      .mockResolvedValue({} as any);
-    const dbSpy = jest
-      .spyOn(MongoClient.prototype, "db")
-      .mockReturnValue(mockDb as any);
-
-    const validUri = "mongodb://127.0.0.1:27017";
-    await municipalDataMongodbClient.connect(validUri, "custom-municipal-db");
-
-    expect(municipalDataMongodbClient.getDb().databaseName).toBe(
-      "custom-municipal-db",
-    );
-
-    connectSpy.mockRestore();
-    dbSpy.mockRestore();
-  });
-});
+import { municipalDataMongodbClient } from "../mongodb-client";
+import { MongoClient } from "mongodb";
+
+describe("MunicipalDataMongoDBClient Validation", () => {
+  const originalEnv = process.env;
+
+  beforeEach(() => {
+    process.env = { ...originalEnv };
+    delete process.env.MONGO_URI;
+    delete process.env.MONGODB_URI;
+
+    // Force reset singleton state
+    (municipalDataMongodbClient as any).client = null;
+    (municipalDataMongodbClient as any).db = null;
+  });
+
+  afterAll(async () => {
+    process.env = originalEnv;
+    await municipalDataMongodbClient.disconnect();
+  });
+
+  it("should succeed with default database name if only URI is provided", async () => {
+    const mockDb = { databaseName: "municipal-data" };
+    const connectSpy = jest
+      .spyOn(MongoClient.prototype, "connect")
+      .mockResolvedValue({} as any);
+    const dbSpy = jest
+      .spyOn(MongoClient.prototype, "db")
+      .mockReturnValue(mockDb as any);
+
+    const validUri = "mongodb://127.0.0.1:27017";
+    await municipalDataMongodbClient.connect(validUri);
+
+    expect(municipalDataMongodbClient.getDb()).toBeDefined();
+    expect(municipalDataMongodbClient.getDb().databaseName).toBe(
+      "municipal-data",
+    );
+
+    connectSpy.mockRestore();
+    dbSpy.mockRestore();
+  });
+
+  it("should allow overriding the default database name", async () => {
+    const mockDb = { databaseName: "custom-municipal-db" };
+    const connectSpy = jest
+      .spyOn(MongoClient.prototype, "connect")
+      .mockResolvedValue({} as any);
+    const dbSpy = jest
+      .spyOn(MongoClient.prototype, "db")
+      .mockReturnValue(mockDb as any);
+
+    const validUri = "mongodb://127.0.0.1:27017";
+    await municipalDataMongodbClient.connect(validUri, "custom-municipal-db");
+
+    expect(municipalDataMongodbClient.getDb().databaseName).toBe(
+      "custom-municipal-db",
+    );
+
+    connectSpy.mockRestore();
+    dbSpy.mockRestore();
+  });
+});

package/src/municipal/cities/cities.getters.ts

@@ -1,50 +1,50 @@
-import { getDb, ObjectId, City } from "../index";
-import { Collection, Filter, ObjectId as MongoObjectId } from "mongodb";
-
-export const getCitiesCollection = (): Collection<City> => {
-  return getDb().collection<City>("cities");
-};
-
-export const findCities = async (
-  filter: Filter<City> = {},
-): Promise<City[]> => {
-  return await getCitiesCollection().find(filter).toArray();
-};
-
-export const getCityById = async (cityId: string): Promise<City | null> => {
-  const city = await getCitiesCollection().findOne({
-    _id: new ObjectId(cityId),
-  });
-  return city ? city : null;
-};
-
-export const createCity = async (
-  cityData: Omit<City, "_id" | "createdAt" | "updatedAt">,
-): Promise<MongoObjectId> => {
-  const city: Omit<City, "_id"> = {
-    ...cityData,
-    createdAt: new Date(),
-    updatedAt: new Date(),
-  };
-  const { insertedId } = await getCitiesCollection().insertOne(city as City);
-  return insertedId;
-};
-
-export const updateCity = async (
-  cityId: string,
-  data: Partial<Omit<City, "_id" | "createdAt" | "updatedAt">>,
-): Promise<City | null> => {
-  const result = await getCitiesCollection().findOneAndUpdate(
-    { _id: new ObjectId(cityId) },
-    { $set: { ...data, updatedAt: new Date() } },
-    { returnDocument: "after" },
-  );
-  return result || null;
-};
-
-export const deleteCity = async (cityId: string): Promise<boolean> => {
-  const result = await getCitiesCollection().deleteOne({
-    _id: new ObjectId(cityId),
-  });
-  return result.deletedCount > 0;
-};
+import { getDb, ObjectId, City } from "../index";
+import { Collection, Filter, ObjectId as MongoObjectId } from "mongodb";
+
+export const getCitiesCollection = (): Collection<City> => {
+  return getDb().collection<City>("cities");
+};
+
+export const findCities = async (
+  filter: Filter<City> = {},
+): Promise<City[]> => {
+  return await getCitiesCollection().find(filter).toArray();
+};
+
+export const getCityById = async (cityId: string): Promise<City | null> => {
+  const city = await getCitiesCollection().findOne({
+    _id: new ObjectId(cityId),
+  });
+  return city ? city : null;
+};
+
+export const createCity = async (
+  cityData: Omit<City, "_id" | "createdAt" | "updatedAt">,
+): Promise<MongoObjectId> => {
+  const city: Omit<City, "_id"> = {
+    ...cityData,
+    createdAt: new Date(),
+    updatedAt: new Date(),
+  };
+  const { insertedId } = await getCitiesCollection().insertOne(city as City);
+  return insertedId;
+};
+
+export const updateCity = async (
+  cityId: string,
+  data: Partial<Omit<City, "_id" | "createdAt" | "updatedAt">>,
+): Promise<City | null> => {
+  const result = await getCitiesCollection().findOneAndUpdate(
+    { _id: new ObjectId(cityId) },
+    { $set: { ...data, updatedAt: new Date() } },
+    { returnDocument: "after" },
+  );
+  return result || null;
+};
+
+export const deleteCity = async (cityId: string): Promise<boolean> => {
+  const result = await getCitiesCollection().deleteOne({
+    _id: new ObjectId(cityId),
+  });
+  return result.deletedCount > 0;
+};

package/src/municipal/cities/cities.types.ts

@@ -1,11 +1,11 @@
-import { ObjectId, WithId } from "mongodb";
-
-export type City = {
-  _id: ObjectId;
-  createdAt: Date;
-  updatedAt: Date;
-  name: string;
-  displayName: string;
-};
-
-export type CityDoc = WithId<City>;
+import { ObjectId, WithId } from "mongodb";
+
+export type City = {
+  _id: ObjectId;
+  createdAt: Date;
+  updatedAt: Date;
+  name: string;
+  displayName: string;
+};
+
+export type CityDoc = WithId<City>;

package/src/municipal/cities/index.ts

@@ -1,2 +1,2 @@
-export * from "./cities.getters";
-export type { City, CityDoc } from "./cities.types";
+export * from "./cities.getters";
+export type { City, CityDoc } from "./cities.types";