@talkpilot/core-db 1.3.5 → 1.3.7

package/src/utils/validation.ts

@@ -1,23 +1,23 @@
-/**
- * Simple validation utilities for the core-db package.
- * Designed to be lightweight and only run when needed.
- */
-
-export const validateConfig = (configName: string, value?: string): string => {
-  if (!value || value.trim() === "") {
-    throw new Error(
-      `[core-db] Configuration Error: '${configName}' is missing. ` +
-        `Please provide it via parameters or set the corresponding environment variable.`,
-    );
-  }
-  return value;
-};
-
-export const validateMongoUri = (uri: string): void => {
-  if (!uri.startsWith("mongodb://") && !uri.startsWith("mongodb+srv://")) {
-    throw new Error(
-      `[core-db] Connection Error: The provided MongoDB URI is invalid. ` +
-        `It must start with 'mongodb://' or 'mongodb+srv://'. Received: '${uri}'`,
-    );
-  }
-};
+/**
+ * Simple validation utilities for the core-db package.
+ * Designed to be lightweight and only run when needed.
+ */
+
+export const validateConfig = (configName: string, value?: string): string => {
+  if (!value || value.trim() === "") {
+    throw new Error(
+      `[core-db] Configuration Error: '${configName}' is missing. ` +
+        `Please provide it via parameters or set the corresponding environment variable.`,
+    );
+  }
+  return value;
+};
+
+export const validateMongoUri = (uri: string): void => {
+  if (!uri.startsWith("mongodb://") && !uri.startsWith("mongodb+srv://")) {
+    throw new Error(
+      `[core-db] Connection Error: The provided MongoDB URI is invalid. ` +
+        `It must start with 'mongodb://' or 'mongodb+srv://'. Received: '${uri}'`,
+    );
+  }
+};

package/src/websitalk/index.ts

@@ -1,15 +1,15 @@
-import { Db, ObjectId as MongoObjectId } from "mongodb";
-
-export * from "./scans";
-export { websitalkMongodbClient } from "./mongodb-client";
-
-let db: Db;
-export const setDb = (d: Db) => {
-  db = d;
-};
-
-export const getDb = (): Db => {
-  if (!db) throw new Error("Website Talk DB not initialised");
-  return db;
-};
-export const ObjectId = MongoObjectId;
+import { Db, ObjectId as MongoObjectId } from "mongodb";
+
+export * from "./scans";
+export { websitalkMongodbClient } from "./mongodb-client";
+
+let db: Db;
+export const setDb = (d: Db) => {
+  db = d;
+};
+
+export const getDb = (): Db => {
+  if (!db) throw new Error("Website Talk DB not initialised");
+  return db;
+};
+export const ObjectId = MongoObjectId;

package/src/websitalk/mongodb-client.ts

@@ -1,61 +1,61 @@
-import { MongoClient, Db } from "mongodb";
-import { setDb } from "./index";
-import { validateConfig, validateMongoUri } from "../utils/validation";
-
-class WebsitalkMongoDBClient {
-  private client: MongoClient | null = null;
-  private db: Db | null = null;
-  private readonly defaultDbName = "website-talk";
-
-  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.WEBSITALK_DB_NAME || this.defaultDbName;
-      this.db = this.client.db(targetDbName);
-      setDb(this.db);
-      console.info(`[core-db] Website Talk MongoDB connected: ${targetDbName}`);
-    } catch (error) {
-      console.error("[core-db] Website Talk 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("Website Talk MongoDB disconnected successfully");
-      } catch (error) {
-        console.error("[core-db] Website Talk disconnection failed", error);
-        throw error;
-      }
-    }
-  }
-
-  getDb(): Db {
-    if (!this.db) {
-      throw new Error(
-        "Website Talk database not initialized. Call connect() first.",
-      );
-    }
-    return this.db;
-  }
-
-  isConnected(): boolean {
-    return this.client !== null && this.client !== undefined;
-  }
-}
-
-export const websitalkMongodbClient = new WebsitalkMongoDBClient();
+import { MongoClient, Db } from "mongodb";
+import { setDb } from "./index";
+import { validateConfig, validateMongoUri } from "../utils/validation";
+
+class WebsitalkMongoDBClient {
+  private client: MongoClient | null = null;
+  private db: Db | null = null;
+  private readonly defaultDbName = "website-talk";
+
+  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.WEBSITALK_DB_NAME || this.defaultDbName;
+      this.db = this.client.db(targetDbName);
+      setDb(this.db);
+      console.info(`[core-db] Website Talk MongoDB connected: ${targetDbName}`);
+    } catch (error) {
+      console.error("[core-db] Website Talk 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("Website Talk MongoDB disconnected successfully");
+      } catch (error) {
+        console.error("[core-db] Website Talk disconnection failed", error);
+        throw error;
+      }
+    }
+  }
+
+  getDb(): Db {
+    if (!this.db) {
+      throw new Error(
+        "Website Talk database not initialized. Call connect() first.",
+      );
+    }
+    return this.db;
+  }
+
+  isConnected(): boolean {
+    return this.client !== null && this.client !== undefined;
+  }
+}
+
+export const websitalkMongodbClient = new WebsitalkMongoDBClient();

package/src/websitalk/scans/__tests__/scans.spec.ts

@@ -1,218 +1,218 @@
-import {
-  getScansCollection,
-  getScansByClientAndDateRange,
-  getScanFieldsByClientAndDateRange,
-  findScansByQuery,
-  countScans,
-  createScanDoc,
-  updateScanDoc,
-  getActiveScanStatus,
-} from "../scans.getters";
-import { createScanFixture } from "../../../test-utils/factories";
-import { ObjectId } from "mongodb";
-
-describe("db.websitalk.scans", () => {
-  describe("getScansByClientAndDateRange()", () => {
-    it("should return full scan documents within the date range", async () => {
-      const clientId = "dateRangeClient";
-      const startDate = new Date("2023-05-01");
-      const endDate = new Date("2023-05-31");
-
-      const scanInside = createScanFixture({ clientId, status: "COMPLETED" });
-      const scanBefore = createScanFixture({ clientId });
-      const scanAfter = createScanFixture({ clientId });
-
-      await getScansCollection().insertMany([
-        { ...scanInside, createdAt: new Date("2023-05-15") },
-        { ...scanBefore, createdAt: new Date("2023-04-30") },
-        { ...scanAfter, createdAt: new Date("2023-06-01") },
-      ]);
-
-      const result = await getScansByClientAndDateRange(
-        clientId,
-        startDate,
-        endDate,
-      );
-
-      expect(result.length).toBe(1);
-      expect(result[0]).toMatchObject({
-        clientId,
-        baseUrl: scanInside.baseUrl,
-        status: "COMPLETED",
-      });
-      expect(result[0]).toHaveProperty("siteChrome");
-      expect(result[0]).toHaveProperty("skipped");
-    });
-
-    it("should respect the date range boundaries (inclusive)", async () => {
-      const clientId = "boundaryClient";
-      const onStart = createScanFixture({ clientId });
-      const onEnd = createScanFixture({ clientId });
-
-      await getScansCollection().insertMany([
-        { ...onStart, createdAt: new Date("2023-05-01") },
-        { ...onEnd, createdAt: new Date("2023-05-31") },
-      ]);
-
-      const result = await getScansByClientAndDateRange(
-        clientId,
-        new Date("2023-05-01"),
-        new Date("2023-05-31"),
-      );
-
-      expect(result.length).toBe(2);
-    });
-  });
-
-  describe("getScanFieldsByClientAndDateRange()", () => {
-    it("should return only the requested fields (plus _id)", async () => {
-      const clientId = "projectionClient";
-      const scan = createScanFixture({
-        clientId,
-        status: "COMPLETED",
-        siteChrome: { url: "https://example.com", sourceType: "site_chrome" },
-        skipped: [{ path: "/broken", reason: "HTTP 500" }],
-      });
-
-      await getScansCollection().insertOne({
-        ...scan,
-        createdAt: new Date("2023-05-15"),
-      });
-
-      const [result] = await getScanFieldsByClientAndDateRange(
-        clientId,
-        new Date("2023-05-01"),
-        new Date("2023-05-31"),
-        ["clientId", "baseUrl", "status"],
-      );
-
-      expect(result).toMatchObject({
-        clientId,
-        baseUrl: scan.baseUrl,
-        status: "COMPLETED",
-      });
-      expect(result).toHaveProperty("_id");
-      expect(result).not.toHaveProperty("siteChrome");
-      expect(result).not.toHaveProperty("skipped");
-      expect(result).not.toHaveProperty("createdAt");
-    });
-  });
-
-  describe("findScansByQuery() / countScans()", () => {
-    it("should find scans matching a raw filter and count them", async () => {
-      const clientId = "queryClient";
-      const completed = createScanFixture({ clientId, status: "COMPLETED" });
-      const scanning = createScanFixture({ clientId, status: "SCANNING" });
-
-      await getScansCollection().insertMany([completed, scanning]);
-
-      const result = await findScansByQuery({ clientId, status: "COMPLETED" });
-      const count = await countScans({ clientId });
-
-      expect(result.length).toBe(1);
-      expect(result[0].baseUrl).toBe(completed.baseUrl);
-      expect(count).toBe(2);
-    });
-  });
-
-  describe("createScanDoc()", () => {
-    it("should insert a scan with default values for the rest of the fields", async () => {
-      const clientId = "createClient";
-      const baseUrl = "https://example.com";
-
-      const { insertedId } = await createScanDoc({ clientId, baseUrl });
-
-      const result = await getScansCollection().findOne({ _id: insertedId });
-
-      expect(result).toMatchObject({
-        clientId,
-        baseUrl,
-        status: "CHECKING",
-        activeTasksCount: 0,
-        pagesScanned: 0,
-        pagesSkipped: 0,
-        skipped: [],
-        siteChrome: {},
-      });
-      expect(result?.createdAt).toBeInstanceOf(Date);
-      expect(result?.updatedAt).toBeInstanceOf(Date);
-    });
-  });
-
-  describe("updateScanDoc()", () => {
-    it("should update the given fields and bump updatedAt", async () => {
-      const scan = createScanFixture({ status: "SCANNING", pagesScanned: 0 });
-      const { insertedId } = await getScansCollection().insertOne(scan);
-
-      const result = await updateScanDoc(insertedId, {
-        status: "COMPLETED",
-        pagesScanned: 10,
-      });
-
-      expect(result).toMatchObject({
-        _id: insertedId,
-        status: "COMPLETED",
-        pagesScanned: 10,
-      });
-      expect(result?.updatedAt.getTime()).toBeGreaterThan(
-        scan.updatedAt.getTime(),
-      );
-    });
-
-    it("should return null when the scan does not exist", async () => {
-      const result = await updateScanDoc(new ObjectId(), { status: "FAILED" });
-
-      expect(result).toBeNull();
-    });
-  });
-
-  describe("getActiveScanStatus()", () => {
-    it("should return isActive: true with the status when the latest scan is still in progress", async () => {
-      const clientId = "activeClient";
-
-      await getScansCollection().insertMany([
-        createScanFixture({
-          clientId,
-          status: "COMPLETED",
-          createdAt: new Date("2023-05-01"),
-        }),
-        createScanFixture({
-          clientId,
-          status: "SCANNING",
-          createdAt: new Date("2023-05-15"),
-        }),
-      ]);
-
-      const result = await getActiveScanStatus(clientId);
-
-      expect(result).toEqual({ isActive: true, status: "SCANNING" });
-    });
-
-    it("should return isActive: false when the latest scan finished (COMPLETED / FAILED)", async () => {
-      const clientId = "finishedClient";
-
-      await getScansCollection().insertMany([
-        createScanFixture({
-          clientId,
-          status: "SCANNING",
-          createdAt: new Date("2023-05-01"),
-        }),
-        createScanFixture({
-          clientId,
-          status: "FAILED",
-          createdAt: new Date("2023-05-15"),
-        }),
-      ]);
-
-      const result = await getActiveScanStatus(clientId);
-
-      expect(result).toEqual({ isActive: false });
-    });
-
-    it("should return isActive: false when the client has no scans", async () => {
-      const result = await getActiveScanStatus("noScansClient");
-
-      expect(result).toEqual({ isActive: false });
-    });
-  });
-});
+import {
+  getScansCollection,
+  getScansByClientAndDateRange,
+  getScanFieldsByClientAndDateRange,
+  findScansByQuery,
+  countScans,
+  createScanDoc,
+  updateScanDoc,
+  getActiveScanStatus,
+} from "../scans.getters";
+import { createScanFixture } from "../../../test-utils/factories";
+import { ObjectId } from "mongodb";
+
+describe("db.websitalk.scans", () => {
+  describe("getScansByClientAndDateRange()", () => {
+    it("should return full scan documents within the date range", async () => {
+      const clientId = "dateRangeClient";
+      const startDate = new Date("2023-05-01");
+      const endDate = new Date("2023-05-31");
+
+      const scanInside = createScanFixture({ clientId, status: "COMPLETED" });
+      const scanBefore = createScanFixture({ clientId });
+      const scanAfter = createScanFixture({ clientId });
+
+      await getScansCollection().insertMany([
+        { ...scanInside, createdAt: new Date("2023-05-15") },
+        { ...scanBefore, createdAt: new Date("2023-04-30") },
+        { ...scanAfter, createdAt: new Date("2023-06-01") },
+      ]);
+
+      const result = await getScansByClientAndDateRange(
+        clientId,
+        startDate,
+        endDate,
+      );
+
+      expect(result.length).toBe(1);
+      expect(result[0]).toMatchObject({
+        clientId,
+        baseUrl: scanInside.baseUrl,
+        status: "COMPLETED",
+      });
+      expect(result[0]).toHaveProperty("siteChrome");
+      expect(result[0]).toHaveProperty("skipped");
+    });
+
+    it("should respect the date range boundaries (inclusive)", async () => {
+      const clientId = "boundaryClient";
+      const onStart = createScanFixture({ clientId });
+      const onEnd = createScanFixture({ clientId });
+
+      await getScansCollection().insertMany([
+        { ...onStart, createdAt: new Date("2023-05-01") },
+        { ...onEnd, createdAt: new Date("2023-05-31") },
+      ]);
+
+      const result = await getScansByClientAndDateRange(
+        clientId,
+        new Date("2023-05-01"),
+        new Date("2023-05-31"),
+      );
+
+      expect(result.length).toBe(2);
+    });
+  });
+
+  describe("getScanFieldsByClientAndDateRange()", () => {
+    it("should return only the requested fields (plus _id)", async () => {
+      const clientId = "projectionClient";
+      const scan = createScanFixture({
+        clientId,
+        status: "COMPLETED",
+        siteChrome: { url: "https://example.com", sourceType: "site_chrome" },
+        skipped: [{ path: "/broken", reason: "HTTP 500" }],
+      });
+
+      await getScansCollection().insertOne({
+        ...scan,
+        createdAt: new Date("2023-05-15"),
+      });
+
+      const [result] = await getScanFieldsByClientAndDateRange(
+        clientId,
+        new Date("2023-05-01"),
+        new Date("2023-05-31"),
+        ["clientId", "baseUrl", "status"],
+      );
+
+      expect(result).toMatchObject({
+        clientId,
+        baseUrl: scan.baseUrl,
+        status: "COMPLETED",
+      });
+      expect(result).toHaveProperty("_id");
+      expect(result).not.toHaveProperty("siteChrome");
+      expect(result).not.toHaveProperty("skipped");
+      expect(result).not.toHaveProperty("createdAt");
+    });
+  });
+
+  describe("findScansByQuery() / countScans()", () => {
+    it("should find scans matching a raw filter and count them", async () => {
+      const clientId = "queryClient";
+      const completed = createScanFixture({ clientId, status: "COMPLETED" });
+      const scanning = createScanFixture({ clientId, status: "SCANNING" });
+
+      await getScansCollection().insertMany([completed, scanning]);
+
+      const result = await findScansByQuery({ clientId, status: "COMPLETED" });
+      const count = await countScans({ clientId });
+
+      expect(result.length).toBe(1);
+      expect(result[0].baseUrl).toBe(completed.baseUrl);
+      expect(count).toBe(2);
+    });
+  });
+
+  describe("createScanDoc()", () => {
+    it("should insert a scan with default values for the rest of the fields", async () => {
+      const clientId = "createClient";
+      const baseUrl = "https://example.com";
+
+      const { insertedId } = await createScanDoc({ clientId, baseUrl });
+
+      const result = await getScansCollection().findOne({ _id: insertedId });
+
+      expect(result).toMatchObject({
+        clientId,
+        baseUrl,
+        status: "CHECKING",
+        activeTasksCount: 0,
+        pagesScanned: 0,
+        pagesSkipped: 0,
+        skipped: [],
+        siteChrome: {},
+      });
+      expect(result?.createdAt).toBeInstanceOf(Date);
+      expect(result?.updatedAt).toBeInstanceOf(Date);
+    });
+  });
+
+  describe("updateScanDoc()", () => {
+    it("should update the given fields and bump updatedAt", async () => {
+      const scan = createScanFixture({ status: "SCANNING", pagesScanned: 0 });
+      const { insertedId } = await getScansCollection().insertOne(scan);
+
+      const result = await updateScanDoc(insertedId, {
+        status: "COMPLETED",
+        pagesScanned: 10,
+      });
+
+      expect(result).toMatchObject({
+        _id: insertedId,
+        status: "COMPLETED",
+        pagesScanned: 10,
+      });
+      expect(result?.updatedAt.getTime()).toBeGreaterThan(
+        scan.updatedAt.getTime(),
+      );
+    });
+
+    it("should return null when the scan does not exist", async () => {
+      const result = await updateScanDoc(new ObjectId(), { status: "FAILED" });
+
+      expect(result).toBeNull();
+    });
+  });
+
+  describe("getActiveScanStatus()", () => {
+    it("should return isActive: true with the status when the latest scan is still in progress", async () => {
+      const clientId = "activeClient";
+
+      await getScansCollection().insertMany([
+        createScanFixture({
+          clientId,
+          status: "COMPLETED",
+          createdAt: new Date("2023-05-01"),
+        }),
+        createScanFixture({
+          clientId,
+          status: "SCANNING",
+          createdAt: new Date("2023-05-15"),
+        }),
+      ]);
+
+      const result = await getActiveScanStatus(clientId);
+
+      expect(result).toEqual({ isActive: true, status: "SCANNING" });
+    });
+
+    it("should return isActive: false when the latest scan finished (COMPLETED / FAILED)", async () => {
+      const clientId = "finishedClient";
+
+      await getScansCollection().insertMany([
+        createScanFixture({
+          clientId,
+          status: "SCANNING",
+          createdAt: new Date("2023-05-01"),
+        }),
+        createScanFixture({
+          clientId,
+          status: "FAILED",
+          createdAt: new Date("2023-05-15"),
+        }),
+      ]);
+
+      const result = await getActiveScanStatus(clientId);
+
+      expect(result).toEqual({ isActive: false });
+    });
+
+    it("should return isActive: false when the client has no scans", async () => {
+      const result = await getActiveScanStatus("noScansClient");
+
+      expect(result).toEqual({ isActive: false });
+    });
+  });
+});

package/src/websitalk/scans/index.ts

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